com.softlayer.api.service.product.pkg.Locations Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.product.pkg;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Location;
import com.softlayer.api.service.product.Package;

/**
 * Most packages are available in many locations. This object describes that availability for each package. 
 *
 * @see SoftLayer_Product_Package_Locations
 */
@ApiType("SoftLayer_Product_Package_Locations")
public class Locations extends Entity {

    /**
     * The location to which this object belongs.
     */
    @ApiProperty
    protected Location location;

    public Location getLocation() {
        return location;
    }

    public void setLocation(Location location) {
        this.location = location;
    }

    /**
     * The package to which this object belongs.
     */
    @ApiProperty("package")
    protected Package locationsPackage;

    public Package getLocationsPackage() {
        return locationsPackage;
    }

    public void setLocationsPackage(Package locationsPackage) {
        this.locationsPackage = locationsPackage;
    }

    /**
     * This describes the availability of the package tied to this location.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String deliveryTimeInformation;

    public String getDeliveryTimeInformation() {
        return deliveryTimeInformation;
    }

    public void setDeliveryTimeInformation(String deliveryTimeInformation) {
        deliveryTimeInformationSpecified = true;
        this.deliveryTimeInformation = deliveryTimeInformation;
    }

    protected boolean deliveryTimeInformationSpecified;

    public boolean isDeliveryTimeInformationSpecified() {
        return deliveryTimeInformationSpecified;
    }

    public void unsetDeliveryTimeInformation() {
        deliveryTimeInformation = null;
        deliveryTimeInformationSpecified = false;
    }

    /**
     * A simple flag which describes whether or not this location is available for this package.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long isAvailable;

    public Long getIsAvailable() {
        return isAvailable;
    }

    public void setIsAvailable(Long isAvailable) {
        isAvailableSpecified = true;
        this.isAvailable = isAvailable;
    }

    protected boolean isAvailableSpecified;

    public boolean isIsAvailableSpecified() {
        return isAvailableSpecified;
    }

    public void unsetIsAvailable() {
        isAvailable = null;
        isAvailableSpecified = false;
    }

    /**
     * The location id tied to this object.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long locationId;

    public Long getLocationId() {
        return locationId;
    }

    public void setLocationId(Long locationId) {
        locationIdSpecified = true;
        this.locationId = locationId;
    }

    protected boolean locationIdSpecified;

    public boolean isLocationIdSpecified() {
        return locationIdSpecified;
    }

    public void unsetLocationId() {
        locationId = null;
        locationIdSpecified = false;
    }

    /**
     * The SoftLayer_Product_Package ID tied to this object.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long packageId;

    public Long getPackageId() {
        return packageId;
    }

    public void setPackageId(Long packageId) {
        packageIdSpecified = true;
        this.packageId = packageId;
    }

    protected boolean packageIdSpecified;

    public boolean isPackageIdSpecified() {
        return packageIdSpecified;
    }

    public void unsetPackageId() {
        packageId = null;
        packageIdSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public com.softlayer.api.service.Location.Mask location() {
            return withSubMask("location", com.softlayer.api.service.Location.Mask.class);
        }

        public com.softlayer.api.service.product.Package.Mask locationsPackage() {
            return withSubMask("package", com.softlayer.api.service.product.Package.Mask.class);
        }

        public Mask deliveryTimeInformation() {
            withLocalProperty("deliveryTimeInformation");
            return this;
        }

        public Mask isAvailable() {
            withLocalProperty("isAvailable");
            return this;
        }

        public Mask locationId() {
            withLocalProperty("locationId");
            return this;
        }

        public Mask packageId() {
            withLocalProperty("packageId");
            return this;
        }

    }

}