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

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.Item;
import com.softlayer.api.service.layout.container.Type;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Layout_Container contains definitions for default page layouts 
 *
 * @see SoftLayer_Layout_Container
 */
@ApiType("SoftLayer_Layout_Container")
public class Container extends Entity {

    /**
     * The type of the layout container object
     */
    @ApiProperty
    protected Type layoutContainerType;

    public Type getLayoutContainerType() {
        return layoutContainerType;
    }

    public void setLayoutContainerType(Type layoutContainerType) {
        this.layoutContainerType = layoutContainerType;
    }

    /**
     * The layout items assigned to this layout container
     */
    @ApiProperty
    protected List layoutItems;

    public List getLayoutItems() {
        if (layoutItems == null) {
            layoutItems = new ArrayList();
        }
        return layoutItems;
    }

    /**
     * The internal identifier of a layout container
     */
    @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;
    }

    /**
     * The unique key name of the layout container, used primarily for programmatic purposes
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String keyname;

    public String getKeyname() {
        return keyname;
    }

    public void setKeyname(String keyname) {
        keynameSpecified = true;
        this.keyname = keyname;
    }

    protected boolean keynameSpecified;

    public boolean isKeynameSpecified() {
        return keynameSpecified;
    }

    public void unsetKeyname() {
        keyname = null;
        keynameSpecified = false;
    }

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

    public Long getLayoutContainerTypeId() {
        return layoutContainerTypeId;
    }

    public void setLayoutContainerTypeId(Long layoutContainerTypeId) {
        layoutContainerTypeIdSpecified = true;
        this.layoutContainerTypeId = layoutContainerTypeId;
    }

    protected boolean layoutContainerTypeIdSpecified;

    public boolean isLayoutContainerTypeIdSpecified() {
        return layoutContainerTypeIdSpecified;
    }

    public void unsetLayoutContainerTypeId() {
        layoutContainerTypeId = null;
        layoutContainerTypeIdSpecified = false;
    }

    /**
     * The friendly name of the layout container
     */
    @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;
    }

    /**
     * A count of the layout items assigned to this layout container
     */
    @ApiProperty
    protected Long layoutItemCount;

    public Long getLayoutItemCount() {
        return layoutItemCount;
    }

    public void setLayoutItemCount(Long layoutItemCount) {
        this.layoutItemCount = layoutItemCount;
    }

    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 containers are used in the customization of the Portal 4 customer experience. 

     * 

     * A single page in the portal can be thought of as a layout container. The container houses individual [[SoftLayer_Layout_Item|layout items]], which are the elements of the page (e.g., Ticket list). Layout containers can be added to [[SoftLayer_Layout_Profile|layout profiles]], allowing for full customization of the container's related items. 
     *
     * @see SoftLayer_Layout_Container
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Layout_Container")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * Use this method to retrieve all active layout containers that can be customized. 
         *
         * @see SoftLayer_Layout_Container::getAllObjects
         */
        @ApiMethod
        public List getAllObjects();

        /**
         * @see SoftLayer_Layout_Container::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Container getObject();

        /**
         * The type of the layout container object
         *
         * @see SoftLayer_Layout_Container::getLayoutContainerType
         */
        @ApiMethod(instanceRequired = true)
        public Type getLayoutContainerType();

        /**
         * The layout items assigned to this layout container
         *
         * @see SoftLayer_Layout_Container::getLayoutItems
         */
        @ApiMethod(instanceRequired = true)
        public List getLayoutItems();

    }

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

        public Future getAllObjects(ResponseHandler> callback);

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

        public Future getObject(ResponseHandler callback);

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

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

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

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

    }

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

        public com.softlayer.api.service.layout.container.Type.Mask layoutContainerType() {
            return withSubMask("layoutContainerType", com.softlayer.api.service.layout.container.Type.Mask.class);
        }

        public Item.Mask layoutItems() {
            return withSubMask("layoutItems", Item.Mask.class);
        }

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

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

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

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

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

    }

}