com.softlayer.api.service.configuration.template.section.definition.Group 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.configuration.template.section.definition;

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

/**
 * Configuration definition group gives you details of the definition and allows extra functionality. 

 * 

 *
 *
 * @see SoftLayer_Configuration_Template_Section_Definition_Group
 */
@ApiType("SoftLayer_Configuration_Template_Section_Definition_Group")
public class Group extends Entity {

    @ApiProperty
    protected Group parent;

    public Group getParent() {
        return parent;
    }

    public void setParent(Group parent) {
        this.parent = parent;
    }

    /**
     * Created date
     */
    @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;
    }

    /**
     * Internal Description of a definition group.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String description;

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        descriptionSpecified = true;
        this.description = description;
    }

    protected boolean descriptionSpecified;

    public boolean isDescriptionSpecified() {
        return descriptionSpecified;
    }

    public void unsetDescription() {
        description = null;
        descriptionSpecified = false;
    }

    /**
     * Internal identifier of a definition group.
     */
    @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;
    }

    /**
     * Internal Definition group name.
     */
    @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;
    }

    /**
     * Sort order
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long sortOrder;

    public Long getSortOrder() {
        return sortOrder;
    }

    public void setSortOrder(Long sortOrder) {
        sortOrderSpecified = true;
        this.sortOrder = sortOrder;
    }

    protected boolean sortOrderSpecified;

    public boolean isSortOrderSpecified() {
        return sortOrderSpecified;
    }

    public void unsetSortOrder() {
        sortOrder = null;
        sortOrderSpecified = false;
    }

    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());
    }

    /**
     * Configuration definition groups help categorize definitions. 
     *
     * @see SoftLayer_Configuration_Template_Section_Definition_Group
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Configuration_Template_Section_Definition_Group")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * Get all configuration definition group objects. 

         * 

         * ''getAllGroups'' returns an array of SoftLayer_Configuration_Template_Section_Definition_Group objects upon success. 
         *
         * @see SoftLayer_Configuration_Template_Section_Definition_Group::getAllGroups
         */
        @ApiMethod
        public List getAllGroups();

        /**
         * @see SoftLayer_Configuration_Template_Section_Definition_Group::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Group getObject();

        /**
         * @see SoftLayer_Configuration_Template_Section_Definition_Group::getParent
         */
        @ApiMethod(instanceRequired = true)
        public Group getParent();

    }

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

        public Future getAllGroups(ResponseHandler> callback);

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

        public Future getObject(ResponseHandler callback);

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

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

    }

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

        public Group.Mask parent() {
            return withSubMask("parent", Group.Mask.class);
        }

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

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

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

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

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

    }

}