com.softlayer.api.service.container.account.discount.Program 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.container.account.discount;

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

/**
 * SoftLayer_Container_Account_Discount_Program models a single outbound object for a graph of given data sets.
 *
 * @see SoftLayer_Container_Account_Discount_Program
 */
@ApiType("SoftLayer_Container_Account_Discount_Program")
public class Program extends Entity {

    /**
     * The credit allowance that has already been applied during the current billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal appliedCredit;

    public BigDecimal getAppliedCredit() {
        return appliedCredit;
    }

    public void setAppliedCredit(BigDecimal appliedCredit) {
        appliedCreditSpecified = true;
        this.appliedCredit = appliedCredit;
    }

    protected boolean appliedCreditSpecified;

    public boolean isAppliedCreditSpecified() {
        return appliedCreditSpecified;
    }

    public void unsetAppliedCredit() {
        appliedCredit = null;
        appliedCreditSpecified = false;
    }

    /**
     * Flag to signify whether the account is a participant in the discount program.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean isParticipant;

    public Boolean getIsParticipant() {
        return isParticipant;
    }

    public void setIsParticipant(Boolean isParticipant) {
        isParticipantSpecified = true;
        this.isParticipant = isParticipant;
    }

    protected boolean isParticipantSpecified;

    public boolean isIsParticipantSpecified() {
        return isParticipantSpecified;
    }

    public void unsetIsParticipant() {
        isParticipant = null;
        isParticipantSpecified = false;
    }

    /**
     * The monthly credit allowance that is available at the beginning of the billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal monthlyCredit;

    public BigDecimal getMonthlyCredit() {
        return monthlyCredit;
    }

    public void setMonthlyCredit(BigDecimal monthlyCredit) {
        monthlyCreditSpecified = true;
        this.monthlyCredit = monthlyCredit;
    }

    protected boolean monthlyCreditSpecified;

    public boolean isMonthlyCreditSpecified() {
        return monthlyCreditSpecified;
    }

    public void unsetMonthlyCredit() {
        monthlyCredit = null;
        monthlyCreditSpecified = false;
    }

    /**
     * The credit allowance (including tax) that is available during the current billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal postTaxRemainingCredit;

    public BigDecimal getPostTaxRemainingCredit() {
        return postTaxRemainingCredit;
    }

    public void setPostTaxRemainingCredit(BigDecimal postTaxRemainingCredit) {
        postTaxRemainingCreditSpecified = true;
        this.postTaxRemainingCredit = postTaxRemainingCredit;
    }

    protected boolean postTaxRemainingCreditSpecified;

    public boolean isPostTaxRemainingCreditSpecified() {
        return postTaxRemainingCreditSpecified;
    }

    public void unsetPostTaxRemainingCredit() {
        postTaxRemainingCredit = null;
        postTaxRemainingCreditSpecified = false;
    }

    /**
     * The date at which the program expires in MM/DD/YYYY format.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar programEndDate;

    public GregorianCalendar getProgramEndDate() {
        return programEndDate;
    }

    public void setProgramEndDate(GregorianCalendar programEndDate) {
        programEndDateSpecified = true;
        this.programEndDate = programEndDate;
    }

    protected boolean programEndDateSpecified;

    public boolean isProgramEndDateSpecified() {
        return programEndDateSpecified;
    }

    public void unsetProgramEndDate() {
        programEndDate = null;
        programEndDateSpecified = false;
    }

    /**
     * The credit allowance that is available during the current billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal remainingCredit;

    public BigDecimal getRemainingCredit() {
        return remainingCredit;
    }

    public void setRemainingCredit(BigDecimal remainingCredit) {
        remainingCreditSpecified = true;
        this.remainingCredit = remainingCredit;
    }

    protected boolean remainingCreditSpecified;

    public boolean isRemainingCreditSpecified() {
        return remainingCreditSpecified;
    }

    public void unsetRemainingCredit() {
        remainingCredit = null;
        remainingCreditSpecified = false;
    }

    /**
     * The tax corresponding to the credit allowance that is available during the current billing cycle. (if applicable)
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal remainingCreditTax;

    public BigDecimal getRemainingCreditTax() {
        return remainingCreditTax;
    }

    public void setRemainingCreditTax(BigDecimal remainingCreditTax) {
        remainingCreditTaxSpecified = true;
        this.remainingCreditTax = remainingCreditTax;
    }

    protected boolean remainingCreditTaxSpecified;

    public boolean isRemainingCreditTaxSpecified() {
        return remainingCreditTaxSpecified;
    }

    public void unsetRemainingCreditTax() {
        remainingCreditTax = null;
        remainingCreditTaxSpecified = false;
    }

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

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

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

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

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

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

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

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

    }

}