com.softlayer.api.service.account.regional.registry.detail.Property 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.account.regional.registry.detail;

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.account.regional.registry.Detail;
import com.softlayer.api.service.account.regional.registry.detail.property.Type;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * Subnet registration properties are used to define various attributes of the [[SoftLayer_Account_Regional_Registry_Detail|detail objects]]. These properties are defined by the [[SoftLayer_Account_Regional_Registry_Detail_Property_Type]] objects, which describe the available value formats. 
 *
 * @see SoftLayer_Account_Regional_Registry_Detail_Property
 */
@ApiType("SoftLayer_Account_Regional_Registry_Detail_Property")
public class Property extends Entity {

    /**
     * The [[SoftLayer_Account_Regional_Registry_Detail]] object this property belongs to
     */
    @ApiProperty
    protected Detail detail;

    public Detail getDetail() {
        return detail;
    }

    public void setDetail(Detail detail) {
        this.detail = detail;
    }

    /**
     * The [[SoftLayer_Account_Regional_Registry_Detail_Property_Type]] object this property belongs to
     */
    @ApiProperty
    protected Type propertyType;

    public Type getPropertyType() {
        return propertyType;
    }

    public void setPropertyType(Type propertyType) {
        this.propertyType = propertyType;
    }

    @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;
    }

    /**
     * Unique ID of the property object 
     */
    @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;
    }

    @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 numeric ID of the related [[SoftLayer_Account_Regional_Registry_Detail_Property_Type|property type object]] 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long propertyTypeId;

    public Long getPropertyTypeId() {
        return propertyTypeId;
    }

    public void setPropertyTypeId(Long propertyTypeId) {
        propertyTypeIdSpecified = true;
        this.propertyTypeId = propertyTypeId;
    }

    protected boolean propertyTypeIdSpecified;

    public boolean isPropertyTypeIdSpecified() {
        return propertyTypeIdSpecified;
    }

    public void unsetPropertyTypeId() {
        propertyTypeId = null;
        propertyTypeIdSpecified = false;
    }

    /**
     * The numeric ID of the related [[SoftLayer_Account_Regional_Registry_Detail|detail object]] 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long registrationDetailId;

    public Long getRegistrationDetailId() {
        return registrationDetailId;
    }

    public void setRegistrationDetailId(Long registrationDetailId) {
        registrationDetailIdSpecified = true;
        this.registrationDetailId = registrationDetailId;
    }

    protected boolean registrationDetailIdSpecified;

    public boolean isRegistrationDetailIdSpecified() {
        return registrationDetailIdSpecified;
    }

    public void unsetRegistrationDetailId() {
        registrationDetailId = null;
        registrationDetailIdSpecified = false;
    }

    /**
     * When multiple properties exist for a property type, defines the position in the sequence of those properties 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long sequencePosition;

    public Long getSequencePosition() {
        return sequencePosition;
    }

    public void setSequencePosition(Long sequencePosition) {
        sequencePositionSpecified = true;
        this.sequencePosition = sequencePosition;
    }

    protected boolean sequencePositionSpecified;

    public boolean isSequencePositionSpecified() {
        return sequencePositionSpecified;
    }

    public void unsetSequencePosition() {
        sequencePosition = null;
        sequencePositionSpecified = false;
    }

    /**
     * The value of the property 
     */
    @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 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());
    }

    /**
     * The subnet registration property is used to define various attributes of [[SoftLayer_Account_Regional_Registry_Detail|detail objects]]. For more information, please see the [[SoftLayer_Account_Regional_Registry_Detail_Property (type)|type overview]]. 
     *
     * @see SoftLayer_Account_Regional_Registry_Detail_Property
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Account_Regional_Registry_Detail_Property")
    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 will create a new SoftLayer_Account_Regional_Registry_Detail_Property object. 

         * 

         * Input - [[SoftLayer_Account_Regional_Registry_Detail_Property (type)|SoftLayer_Account_Regional_Registry_Detail_Property]]  registrationDetailId The numeric ID of the [[SoftLayer_Account_Regional_Registry_Detail|detail object]] this property belongs to
  Required
 Type - integer
 
 
 propertyTypeId  The numeric ID of the associated [[SoftLayer_Account_Regional_Registry_Detail_Property_Type]] object 
  Required
 Type - integer
 
 
 sequencePosition  When more than one property of the same type exists on a detail object, this value determines the position in that collection. This can be thought of more as a sort order. 
  Required
 Type - integer
 
 
 value  The actual value of the property. 
  Required
 Type - string
 
 
  
         *
         * @see SoftLayer_Account_Regional_Registry_Detail_Property::createObject
         */
        @ApiMethod
        public Property createObject(Property templateObject);

        /**
         * Edit multiple [[SoftLayer_Account_Regional_Registry_Detail_Property]] objects. 
         *
         * @see SoftLayer_Account_Regional_Registry_Detail_Property::createObjects
         */
        @ApiMethod
        public List createObjects(List templateObjects);

        /**
         * This method will delete an existing SoftLayer_Account_Regional_Registry_Detail_Property object. 
         *
         * @see SoftLayer_Account_Regional_Registry_Detail_Property::deleteObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean deleteObject();

        /**
         * This method will edit an existing SoftLayer_Account_Regional_Registry_Detail_Property object. For more detail, see [[SoftLayer_Account_Regional_Registry_Detail_Property::createObject|createObject]]. 
         *
         * @see SoftLayer_Account_Regional_Registry_Detail_Property::editObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean editObject(Property templateObject);

        /**
         * Edit multiple [[SoftLayer_Account_Regional_Registry_Detail_Property]] objects. 
         *
         * @see SoftLayer_Account_Regional_Registry_Detail_Property::editObjects
         */
        @ApiMethod
        public Boolean editObjects(List templateObjects);

        /**
         * @see SoftLayer_Account_Regional_Registry_Detail_Property::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Property getObject();

        /**
         * The [[SoftLayer_Account_Regional_Registry_Detail]] object this property belongs to
         *
         * @see SoftLayer_Account_Regional_Registry_Detail_Property::getDetail
         */
        @ApiMethod(instanceRequired = true)
        public Detail getDetail();

        /**
         * The [[SoftLayer_Account_Regional_Registry_Detail_Property_Type]] object this property belongs to
         *
         * @see SoftLayer_Account_Regional_Registry_Detail_Property::getPropertyType
         */
        @ApiMethod(instanceRequired = true)
        public Type getPropertyType();

    }

    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(Property templateObject);

        public Future createObject(Property templateObject, ResponseHandler callback);

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

        public Future createObjects(List templateObjects, 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(Property templateObject);

        public Future editObject(Property templateObject, ResponseHandler callback);

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

        public Future editObjects(List templateObjects, ResponseHandler callback);

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

        public Future getObject(ResponseHandler callback);

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

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

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

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

    }

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

        public com.softlayer.api.service.account.regional.registry.Detail.Mask detail() {
            return withSubMask("detail", com.softlayer.api.service.account.regional.registry.Detail.Mask.class);
        }

        public com.softlayer.api.service.account.regional.registry.detail.property.Type.Mask propertyType() {
            return withSubMask("propertyType", com.softlayer.api.service.account.regional.registry.detail.property.Type.Mask.class);
        }

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

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

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

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

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

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

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

    }

}