com.softlayer.api.service.layout.Profile 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
The newest version!
package com.softlayer.api.service.layout;

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.profile.Preference;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Layout_Profile contains the definition of the layout profile 
 *
 * @see SoftLayer_Layout_Profile
 */
@ApiType("SoftLayer_Layout_Profile")
public class Profile extends Entity {

    @ApiProperty
    protected List layoutContainers;

    public List getLayoutContainers() {
        if (layoutContainers == null) {
            layoutContainers = new ArrayList();
        }
        return layoutContainers;
    }

    @ApiProperty
    protected List layoutPreferences;

    public List getLayoutPreferences() {
        if (layoutPreferences == null) {
            layoutPreferences = new ArrayList();
        }
        return layoutPreferences;
    }

    /**
     * Active status of the layout profile
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long activeFlag;

    public Long getActiveFlag() {
        return activeFlag;
    }

    public void setActiveFlag(Long activeFlag) {
        activeFlagSpecified = true;
        this.activeFlag = activeFlag;
    }

    protected boolean activeFlagSpecified;

    public boolean isActiveFlagSpecified() {
        return activeFlagSpecified;
    }

    public void unsetActiveFlag() {
        activeFlag = null;
        activeFlagSpecified = false;
    }

    /**
     * Timestamp of when the layout profile 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;
    }

    /**
     * The internal identifier of a layout profile
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * Timestamp of when the layout profile 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 friendly name of the layout profile
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        nameSpecified = true;
        this.name = name;
    }

    protected boolean nameSpecified;

    public boolean isNameSpecified() {
        return nameSpecified;
    }

    public void unsetName() {
        name = null;
        nameSpecified = false;
    }

    /**
     * The [[SoftLayer_User_Customer]] owning this layout profile
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long userRecordId;

    public Long getUserRecordId() {
        return userRecordId;
    }

    public void setUserRecordId(Long userRecordId) {
        userRecordIdSpecified = true;
        this.userRecordId = userRecordId;
    }

    protected boolean userRecordIdSpecified;

    public boolean isUserRecordIdSpecified() {
        return userRecordIdSpecified;
    }

    public void unsetUserRecordId() {
        userRecordId = null;
        userRecordIdSpecified = false;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long layoutContainerCount;

    public Long getLayoutContainerCount() {
        return layoutContainerCount;
    }

    public void setLayoutContainerCount(Long layoutContainerCount) {
        this.layoutContainerCount = layoutContainerCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long layoutPreferenceCount;

    public Long getLayoutPreferenceCount() {
        return layoutPreferenceCount;
    }

    public void setLayoutPreferenceCount(Long layoutPreferenceCount) {
        this.layoutPreferenceCount = layoutPreferenceCount;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

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

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * Layout profiles are the primary object used to tie customized portal experiences to the [[SoftLayer_User_Customer|user account]]. 

     * 

     * In order to take full advantage of the flexible customization of the portal, each user must be given one or more layout profiles. Each layout profile is then assigned one of the [[SoftLayer_Layout_Container|layout containers]], thereby giving the user all [[SoftLayer_Layout_Item|items]] and associated [[SoftLayer_Layout_Profile_Preferences|default preferences]]. These default preferences can be modified via the [[SoftLayer_Layout_Profile::modifyPreference()]] method, giving the user their own customized configuration. 
     *
     * @see SoftLayer_Layout_Profile
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Layout_Profile")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * This method creates a new layout profile object. 
         *
         * @see SoftLayer_Layout_Profile::createObject
         */
        @ApiMethod
        public Boolean createObject(Profile templateObject);

        /**
         * This method deletes an existing layout profile and associated custom preferences 
         *
         * @see SoftLayer_Layout_Profile::deleteObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean deleteObject();

        /**
         * This method edits an existing layout profile object by passing in a modified instance of the object. 
         *
         * @see SoftLayer_Layout_Profile::editObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean editObject(Profile templateObject);

        /**
         * @see SoftLayer_Layout_Profile::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Profile getObject();

        /**
         * This method modifies an existing associated [[SoftLayer_Layout_Profile_Preference]] object. If the preference object being modified is a default value object, a new record is created to override the default value. 

         * 

         * Only preferences that are assigned to a profile may be updated. Attempts to update a non-existent preference object will result in an exception being thrown. 
         *
         * @see SoftLayer_Layout_Profile::modifyPreference
         */
        @ApiMethod(instanceRequired = true)
        public Preference modifyPreference(Preference templateObject);

        /**
         * Using this method, multiple [[SoftLayer_Layout_Profile_Preference]] objects may be updated at once. 

         * 

         * Refer to [[SoftLayer_Layout_Profile::modifyPreference()]] for more information. 
         *
         * @see SoftLayer_Layout_Profile::modifyPreferences
         */
        @ApiMethod(instanceRequired = true)
        public List modifyPreferences(List layoutPreferenceObjects);

        /**
         * @see SoftLayer_Layout_Profile::getLayoutContainers
         */
        @ApiMethod(instanceRequired = true)
        public List getLayoutContainers();

        /**
         * @see SoftLayer_Layout_Profile::getLayoutPreferences
         */
        @ApiMethod(instanceRequired = true)
        public List getLayoutPreferences();

    }

    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#createObject}
         */
        public Future createObject(Profile templateObject);

        public Future createObject(Profile templateObject, ResponseHandler callback);

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

        public Future deleteObject(ResponseHandler callback);

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

        public Future editObject(Profile templateObject, ResponseHandler callback);

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

        public Future getObject(ResponseHandler callback);

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

        public Future modifyPreference(Preference templateObject, ResponseHandler callback);

        /**
         * Async version of {@link Service#modifyPreferences}
         */
        public Future> modifyPreferences(List layoutPreferenceObjects);

        public Future modifyPreferences(List layoutPreferenceObjects, ResponseHandler> callback);

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

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

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

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

    }

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

        public Container.Mask layoutContainers() {
            return withSubMask("layoutContainers", Container.Mask.class);
        }

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

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

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

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

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

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

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

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

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

    }

}