com.softlayer.api.service.billing.info.Cycle 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.info;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Entity;
import java.util.GregorianCalendar;

/**
 * The SoftLayer_Billing_Info_Cycle data type models basic information concerning a SoftLayer account's previous and current billing cycles. The information in this class is only populated for SoftLayer customers who are billed monthly. 
 *
 * @see SoftLayer_Billing_Info_Cycle
 */
@ApiType("SoftLayer_Billing_Info_Cycle")
public class Cycle extends Entity {

    /**
     * The account that a current billing cycle is associated with.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

    public void setAccount(Account account) {
        this.account = account;
    }

    /**
     * The ending date of an account's current billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar currentCycleEndDate;

    public GregorianCalendar getCurrentCycleEndDate() {
        return currentCycleEndDate;
    }

    public void setCurrentCycleEndDate(GregorianCalendar currentCycleEndDate) {
        currentCycleEndDateSpecified = true;
        this.currentCycleEndDate = currentCycleEndDate;
    }

    protected boolean currentCycleEndDateSpecified;

    public boolean isCurrentCycleEndDateSpecified() {
        return currentCycleEndDateSpecified;
    }

    public void unsetCurrentCycleEndDate() {
        currentCycleEndDate = null;
        currentCycleEndDateSpecified = false;
    }

    /**
     * The starting date of an account's current billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar currentCycleStartDate;

    public GregorianCalendar getCurrentCycleStartDate() {
        return currentCycleStartDate;
    }

    public void setCurrentCycleStartDate(GregorianCalendar currentCycleStartDate) {
        currentCycleStartDateSpecified = true;
        this.currentCycleStartDate = currentCycleStartDate;
    }

    protected boolean currentCycleStartDateSpecified;

    public boolean isCurrentCycleStartDateSpecified() {
        return currentCycleStartDateSpecified;
    }

    public void unsetCurrentCycleStartDate() {
        currentCycleStartDate = null;
        currentCycleStartDateSpecified = false;
    }

    /**
     * The start date of an account's next billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar nextCycleStartDate;

    public GregorianCalendar getNextCycleStartDate() {
        return nextCycleStartDate;
    }

    public void setNextCycleStartDate(GregorianCalendar nextCycleStartDate) {
        nextCycleStartDateSpecified = true;
        this.nextCycleStartDate = nextCycleStartDate;
    }

    protected boolean nextCycleStartDateSpecified;

    public boolean isNextCycleStartDateSpecified() {
        return nextCycleStartDateSpecified;
    }

    public void unsetNextCycleStartDate() {
        nextCycleStartDate = null;
        nextCycleStartDateSpecified = false;
    }

    /**
     * The ending date of an account's previous billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar previousCycleEndDate;

    public GregorianCalendar getPreviousCycleEndDate() {
        return previousCycleEndDate;
    }

    public void setPreviousCycleEndDate(GregorianCalendar previousCycleEndDate) {
        previousCycleEndDateSpecified = true;
        this.previousCycleEndDate = previousCycleEndDate;
    }

    protected boolean previousCycleEndDateSpecified;

    public boolean isPreviousCycleEndDateSpecified() {
        return previousCycleEndDateSpecified;
    }

    public void unsetPreviousCycleEndDate() {
        previousCycleEndDate = null;
        previousCycleEndDateSpecified = false;
    }

    /**
     * The starting date of an account's previous billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar previousCycleStartDate;

    public GregorianCalendar getPreviousCycleStartDate() {
        return previousCycleStartDate;
    }

    public void setPreviousCycleStartDate(GregorianCalendar previousCycleStartDate) {
        previousCycleStartDateSpecified = true;
        this.previousCycleStartDate = previousCycleStartDate;
    }

    protected boolean previousCycleStartDateSpecified;

    public boolean isPreviousCycleStartDateSpecified() {
        return previousCycleStartDateSpecified;
    }

    public void unsetPreviousCycleStartDate() {
        previousCycleStartDate = null;
        previousCycleStartDateSpecified = false;
    }

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

        public com.softlayer.api.service.Account.Mask account() {
            return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
        }

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

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

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

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

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

    }

}