com.softlayer.api.service.network.subnet.registration.Details 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.network.subnet.registration;

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

/**
 * The SoftLayer_Network_Subnet_Registration_Details objects are used to relate [[SoftLayer_Account_Regional_Registry_Detail]] objects to a [[SoftLayer_Network_Subnet_Registration]] object. This allows for easy reuse of registration details. It is important to note that only one detail object per type may be associated to a registration object. 
 *
 * @see SoftLayer_Network_Subnet_Registration_Details
 */
@ApiType("SoftLayer_Network_Subnet_Registration_Details")
public class Details extends Entity {

    /**
     * The related [[SoftLayer_Account_Regional_Registry_Detail|detail object]].
     */
    @ApiProperty
    protected Detail detail;

    public Detail getDetail() {
        return detail;
    }

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

    /**
     * The related [[SoftLayer_Network_Subnet_Registration|registration object]].
     */
    @ApiProperty
    protected Registration registration;

    public Registration getRegistration() {
        return registration;
    }

    public void setRegistration(Registration registration) {
        this.registration = registration;
    }

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

    /**
     * Numeric ID of the related [[SoftLayer_Account_Regional_Registry_Detail]] object 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long detailId;

    public Long getDetailId() {
        return detailId;
    }

    public void setDetailId(Long detailId) {
        detailIdSpecified = true;
        this.detailId = detailId;
    }

    protected boolean detailIdSpecified;

    public boolean isDetailIdSpecified() {
        return detailIdSpecified;
    }

    public void unsetDetailId() {
        detailId = null;
        detailIdSpecified = false;
    }

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

    /**
     * Numeric ID of the related [[SoftLayer_Network_Subnet_Registration]] object 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long registrationId;

    public Long getRegistrationId() {
        return registrationId;
    }

    public void setRegistrationId(Long registrationId) {
        registrationIdSpecified = true;
        this.registrationId = registrationId;
    }

    protected boolean registrationIdSpecified;

    public boolean isRegistrationIdSpecified() {
        return registrationIdSpecified;
    }

    public void unsetRegistrationId() {
        registrationId = null;
        registrationIdSpecified = 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());
    }

    /**
     * @see SoftLayer_Network_Subnet_Registration_Details
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Network_Subnet_Registration_Details")
    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_Network_Subnet_Registration_Details object. 

         * 

         * Input - [[SoftLayer_Network_Subnet_Registration_Details (type)|SoftLayer_Network_Subnet_Registration_Details]]  detailId  The numeric ID of the [[SoftLayer_Account_Regional_Registry_Detail|detail]] object to relate. 
  Required
 Type - integer
 
 
 registrationId  The numeric ID of the [[SoftLayer_Network_Subnet_Registration|registration]] object to relate. 
  Required
 Type - integer
 
 
  
         *
         * @see SoftLayer_Network_Subnet_Registration_Details::createObject
         */
        @ApiMethod
        public Details createObject(Details templateObject);

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

        /**
         * @see SoftLayer_Network_Subnet_Registration_Details::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Details getObject();

        /**
         * The related [[SoftLayer_Account_Regional_Registry_Detail|detail object]].
         *
         * @see SoftLayer_Network_Subnet_Registration_Details::getDetail
         */
        @ApiMethod(instanceRequired = true)
        public Detail getDetail();

        /**
         * The related [[SoftLayer_Network_Subnet_Registration|registration object]].
         *
         * @see SoftLayer_Network_Subnet_Registration_Details::getRegistration
         */
        @ApiMethod(instanceRequired = true)
        public Registration getRegistration();

    }

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

        public Future createObject(Details templateObject, ResponseHandler callback);

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

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

        /**
         * Async callback version of {@link Service#getRegistration}
         */
        public Future getRegistration(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.network.subnet.Registration.Mask registration() {
            return withSubMask("registration", com.softlayer.api.service.network.subnet.Registration.Mask.class);
        }

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

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

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

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

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

    }

}