com.softlayer.api.service.billing.item.cancellation.request.Item 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.billing.item.cancellation.request;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.billing.item.cancellation.Request;
import java.util.GregorianCalendar;

/**
 * SoftLayer_Billing_Item_Cancellation_Request_Item data type contains a billing item for cancellation. This data type is used to harness billing items to the associated service. 
 *
 * @see SoftLayer_Billing_Item_Cancellation_Request_Item
 */
@ApiType("SoftLayer_Billing_Item_Cancellation_Request_Item")
public class Item extends Entity {

    /**
     * The billing item for cancellation.
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.Item billingItem;

    public com.softlayer.api.service.billing.Item getBillingItem() {
        return billingItem;
    }

    public void setBillingItem(com.softlayer.api.service.billing.Item billingItem) {
        this.billingItem = billingItem;
    }

    /**
     * The service cancellation request that a cancellation item belongs to.
     */
    @ApiProperty
    protected Request cancellationRequest;

    public Request getCancellationRequest() {
        return cancellationRequest;
    }

    public void setCancellationRequest(Request cancellationRequest) {
        this.cancellationRequest = cancellationRequest;
    }

    /**
     * The internal identifier of a billing item
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long billingItemId;

    public Long getBillingItemId() {
        return billingItemId;
    }

    public void setBillingItemId(Long billingItemId) {
        billingItemIdSpecified = true;
        this.billingItemId = billingItemId;
    }

    protected boolean billingItemIdSpecified;

    public boolean isBillingItemIdSpecified() {
        return billingItemIdSpecified;
    }

    public void unsetBillingItemId() {
        billingItemId = null;
        billingItemIdSpecified = false;
    }

    /**
     * A cancellation request's internal identifier.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long cancellationRequestId;

    public Long getCancellationRequestId() {
        return cancellationRequestId;
    }

    public void setCancellationRequestId(Long cancellationRequestId) {
        cancellationRequestIdSpecified = true;
        this.cancellationRequestId = cancellationRequestId;
    }

    protected boolean cancellationRequestIdSpecified;

    public boolean isCancellationRequestIdSpecified() {
        return cancellationRequestIdSpecified;
    }

    public void unsetCancellationRequestId() {
        cancellationRequestId = null;
        cancellationRequestIdSpecified = false;
    }

    /**
     * A cancellation request item's internal identifier.
     */
    @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;
    }

    /**
     * This flag indicated if a billing item should be canceled immediately or not.  Set this flag to true when creating a cancellation request.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean immediateCancellationFlag;

    public Boolean getImmediateCancellationFlag() {
        return immediateCancellationFlag;
    }

    public void setImmediateCancellationFlag(Boolean immediateCancellationFlag) {
        immediateCancellationFlagSpecified = true;
        this.immediateCancellationFlag = immediateCancellationFlag;
    }

    protected boolean immediateCancellationFlagSpecified;

    public boolean isImmediateCancellationFlagSpecified() {
        return immediateCancellationFlagSpecified;
    }

    public void unsetImmediateCancellationFlag() {
        immediateCancellationFlag = null;
        immediateCancellationFlagSpecified = false;
    }

    /**
     * The scheduled cancellation date
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar scheduledCancellationDate;

    public GregorianCalendar getScheduledCancellationDate() {
        return scheduledCancellationDate;
    }

    public void setScheduledCancellationDate(GregorianCalendar scheduledCancellationDate) {
        scheduledCancellationDateSpecified = true;
        this.scheduledCancellationDate = scheduledCancellationDate;
    }

    protected boolean scheduledCancellationDateSpecified;

    public boolean isScheduledCancellationDateSpecified() {
        return scheduledCancellationDateSpecified;
    }

    public void unsetScheduledCancellationDate() {
        scheduledCancellationDate = null;
        scheduledCancellationDateSpecified = false;
    }

    /**
     * The reclaim status of a service.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serviceReclaimStatusCode;

    public String getServiceReclaimStatusCode() {
        return serviceReclaimStatusCode;
    }

    public void setServiceReclaimStatusCode(String serviceReclaimStatusCode) {
        serviceReclaimStatusCodeSpecified = true;
        this.serviceReclaimStatusCode = serviceReclaimStatusCode;
    }

    protected boolean serviceReclaimStatusCodeSpecified;

    public boolean isServiceReclaimStatusCodeSpecified() {
        return serviceReclaimStatusCodeSpecified;
    }

    public void unsetServiceReclaimStatusCode() {
        serviceReclaimStatusCode = null;
        serviceReclaimStatusCodeSpecified = false;
    }

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

        public com.softlayer.api.service.billing.Item.Mask billingItem() {
            return withSubMask("billingItem", com.softlayer.api.service.billing.Item.Mask.class);
        }

        public com.softlayer.api.service.billing.item.cancellation.Request.Mask cancellationRequest() {
            return withSubMask("cancellationRequest", com.softlayer.api.service.billing.item.cancellation.Request.Mask.class);
        }

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

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

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

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

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

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

    }

}