com.softlayer.api.service.layout.profile.Preference 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.layout.profile;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.layout.Container;
import com.softlayer.api.service.layout.Item;
import com.softlayer.api.service.layout.Profile;
import java.util.GregorianCalendar;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Layout_Profile_Preference contains definitions for layout preferences 
 *
 * @see SoftLayer_Layout_Profile_Preference
 */
@ApiType("SoftLayer_Layout_Profile_Preference")
public class Preference extends Entity {

    @ApiProperty
    protected Container layoutContainer;

    public Container getLayoutContainer() {
        return layoutContainer;
    }

    public void setLayoutContainer(Container layoutContainer) {
        this.layoutContainer = layoutContainer;
    }

    @ApiProperty
    protected Item layoutItem;

    public Item getLayoutItem() {
        return layoutItem;
    }

    public void setLayoutItem(Item layoutItem) {
        this.layoutItem = layoutItem;
    }

    @ApiProperty
    protected com.softlayer.api.service.layout.Preference layoutPreference;

    public com.softlayer.api.service.layout.Preference getLayoutPreference() {
        return layoutPreference;
    }

    public void setLayoutPreference(com.softlayer.api.service.layout.Preference layoutPreference) {
        this.layoutPreference = layoutPreference;
    }

    @ApiProperty
    protected Profile layoutProfile;

    public Profile getLayoutProfile() {
        return layoutProfile;
    }

    public void setLayoutProfile(Profile layoutProfile) {
        this.layoutProfile = layoutProfile;
    }

    /**
     * Timestamp of when the preference was created
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar createDate;

    public GregorianCalendar getCreateDate() {
        return createDate;
    }

    public void setCreateDate(GregorianCalendar createDate) {
        createDateSpecified = true;
        this.createDate = createDate;
    }

    protected boolean createDateSpecified;

    public boolean isCreateDateSpecified() {
        return createDateSpecified;
    }

    public void unsetCreateDate() {
        createDate = null;
        createDateSpecified = false;
    }

    /**
     * Indicates whether this is a default value or not
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long defaultValueFlag;

    public Long getDefaultValueFlag() {
        return defaultValueFlag;
    }

    public void setDefaultValueFlag(Long defaultValueFlag) {
        defaultValueFlagSpecified = true;
        this.defaultValueFlag = defaultValueFlag;
    }

    protected boolean defaultValueFlagSpecified;

    public boolean isDefaultValueFlagSpecified() {
        return defaultValueFlagSpecified;
    }

    public void unsetDefaultValueFlag() {
        defaultValueFlag = null;
        defaultValueFlagSpecified = false;
    }

    /**
     * The id of the related [[SoftLayer_Layout_Container]]
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long layoutContainerId;

    public Long getLayoutContainerId() {
        return layoutContainerId;
    }

    public void setLayoutContainerId(Long layoutContainerId) {
        layoutContainerIdSpecified = true;
        this.layoutContainerId = layoutContainerId;
    }

    protected boolean layoutContainerIdSpecified;

    public boolean isLayoutContainerIdSpecified() {
        return layoutContainerIdSpecified;
    }

    public void unsetLayoutContainerId() {
        layoutContainerId = null;
        layoutContainerIdSpecified = false;
    }

    /**
     * The id of the related [[SoftLayer_Layout_Item]]
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long layoutItemId;

    public Long getLayoutItemId() {
        return layoutItemId;
    }

    public void setLayoutItemId(Long layoutItemId) {
        layoutItemIdSpecified = true;
        this.layoutItemId = layoutItemId;
    }

    protected boolean layoutItemIdSpecified;

    public boolean isLayoutItemIdSpecified() {
        return layoutItemIdSpecified;
    }

    public void unsetLayoutItemId() {
        layoutItemId = null;
        layoutItemIdSpecified = false;
    }

    /**
     * The internal identifier of the overridden [[SoftLayer_Layout_Preference]]
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long layoutPreferenceId;

    public Long getLayoutPreferenceId() {
        return layoutPreferenceId;
    }

    public void setLayoutPreferenceId(Long layoutPreferenceId) {
        layoutPreferenceIdSpecified = true;
        this.layoutPreferenceId = layoutPreferenceId;
    }

    protected boolean layoutPreferenceIdSpecified;

    public boolean isLayoutPreferenceIdSpecified() {
        return layoutPreferenceIdSpecified;
    }

    public void unsetLayoutPreferenceId() {
        layoutPreferenceId = null;
        layoutPreferenceIdSpecified = false;
    }

    /**
     * The internal identifier of the related [[SoftLayer_Layout_Profile]]
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long layoutProfileId;

    public Long getLayoutProfileId() {
        return layoutProfileId;
    }

    public void setLayoutProfileId(Long layoutProfileId) {
        layoutProfileIdSpecified = true;
        this.layoutProfileId = layoutProfileId;
    }

    protected boolean layoutProfileIdSpecified;

    public boolean isLayoutProfileIdSpecified() {
        return layoutProfileIdSpecified;
    }

    public void unsetLayoutProfileId() {
        layoutProfileId = null;
        layoutProfileIdSpecified = false;
    }

    /**
     * Timestamp of when the preference was last updated
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar modifyDate;

    public GregorianCalendar getModifyDate() {
        return modifyDate;
    }

    public void setModifyDate(GregorianCalendar modifyDate) {
        modifyDateSpecified = true;
        this.modifyDate = modifyDate;
    }

    protected boolean modifyDateSpecified;

    public boolean isModifyDateSpecified() {
        return modifyDateSpecified;
    }

    public void unsetModifyDate() {
        modifyDate = null;
        modifyDateSpecified = false;
    }

    /**
     * The value overriding the default value
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String value;

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        valueSpecified = true;
        this.value = value;
    }

    protected boolean valueSpecified;

    public boolean isValueSpecified() {
        return valueSpecified;
    }

    public void unsetValue() {
        value = null;
        valueSpecified = false;
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    /**
     * The profile preferences are an aggregation of the default preferences and the customized preferences. 

     * 

     * For each [[SoftLayer_Layout_Profile_Containers|associated container]] on a [[SoftLayer_Layout_Profile|profile]], the [[SoftLayer_Layout_Preference|default preferences]] are inherited through the profile preferences. However, any one of these may be overridden through the [[SoftLayer_Layout_Profile::modifyPreference()]] method. Rather than maintaining two different sets of preferences, all preferences are grouped together through the profile preferences, presenting the customized preferences in place of the default preferences they are overriding. 
     *
     * @see SoftLayer_Layout_Profile_Preference
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Layout_Profile_Preference")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * @see SoftLayer_Layout_Profile_Preference::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Preference getObject();

        /**
         * @see SoftLayer_Layout_Profile_Preference::getLayoutContainer
         */
        @ApiMethod(instanceRequired = true)
        public Container getLayoutContainer();

        /**
         * @see SoftLayer_Layout_Profile_Preference::getLayoutItem
         */
        @ApiMethod(instanceRequired = true)
        public Item getLayoutItem();

        /**
         * @see SoftLayer_Layout_Profile_Preference::getLayoutPreference
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.layout.Preference getLayoutPreference();

        /**
         * @see SoftLayer_Layout_Profile_Preference::getLayoutProfile
         */
        @ApiMethod(instanceRequired = true)
        public Profile getLayoutProfile();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#getLayoutContainer}
         */
        public Future getLayoutContainer();

        /**
         * Async callback version of {@link Service#getLayoutContainer}
         */
        public Future getLayoutContainer(ResponseHandler callback);

        /**
         * Async version of {@link Service#getLayoutItem}
         */
        public Future getLayoutItem();

        /**
         * Async callback version of {@link Service#getLayoutItem}
         */
        public Future getLayoutItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getLayoutPreference}
         */
        public Future getLayoutPreference();

        /**
         * Async callback version of {@link Service#getLayoutPreference}
         */
        public Future getLayoutPreference(ResponseHandler callback);

        /**
         * Async version of {@link Service#getLayoutProfile}
         */
        public Future getLayoutProfile();

        /**
         * Async callback version of {@link Service#getLayoutProfile}
         */
        public Future getLayoutProfile(ResponseHandler callback);

    }

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

        public com.softlayer.api.service.layout.Container.Mask layoutContainer() {
            return withSubMask("layoutContainer", com.softlayer.api.service.layout.Container.Mask.class);
        }

        public com.softlayer.api.service.layout.Item.Mask layoutItem() {
            return withSubMask("layoutItem", com.softlayer.api.service.layout.Item.Mask.class);
        }

        public com.softlayer.api.service.layout.Preference.Mask layoutPreference() {
            return withSubMask("layoutPreference", com.softlayer.api.service.layout.Preference.Mask.class);
        }

        public com.softlayer.api.service.layout.Profile.Mask layoutProfile() {
            return withSubMask("layoutProfile", com.softlayer.api.service.layout.Profile.Mask.class);
        }

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

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

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

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

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

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

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

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

    }

}