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
The newest version!
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. If the lifetime limit has been or soon will be reached, this amount may included credit applied in previous billing cycles. 
     */
    @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;
    }

    /**
     * Credit allowance applied over the course of the entire program enrollment. For enrollments without a lifetime restriction, this property will not be populated as credit will be tracked on a purely monthly basis. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal lifetimeAppliedCredit;

    public BigDecimal getLifetimeAppliedCredit() {
        return lifetimeAppliedCredit;
    }

    public void setLifetimeAppliedCredit(BigDecimal lifetimeAppliedCredit) {
        lifetimeAppliedCreditSpecified = true;
        this.lifetimeAppliedCredit = lifetimeAppliedCredit;
    }

    protected boolean lifetimeAppliedCreditSpecified;

    public boolean isLifetimeAppliedCreditSpecified() {
        return lifetimeAppliedCreditSpecified;
    }

    public void unsetLifetimeAppliedCredit() {
        lifetimeAppliedCredit = null;
        lifetimeAppliedCreditSpecified = false;
    }

    /**
     * Credit allowance available over the course of the entire program enrollment. If null, enrollment credit is applied on a strictly monthly basis and there is no lifetime maximum. Enrollments with non-null lifetime credit will receive the lesser of the remaining monthly credit or the remaining lifetime credit. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal lifetimeCredit;

    public BigDecimal getLifetimeCredit() {
        return lifetimeCredit;
    }

    public void setLifetimeCredit(BigDecimal lifetimeCredit) {
        lifetimeCreditSpecified = true;
        this.lifetimeCredit = lifetimeCredit;
    }

    protected boolean lifetimeCreditSpecified;

    public boolean isLifetimeCreditSpecified() {
        return lifetimeCreditSpecified;
    }

    public void unsetLifetimeCredit() {
        lifetimeCredit = null;
        lifetimeCreditSpecified = false;
    }

    /**
     * Remaining credit allowance available over the remaining duration of the program enrollment. If null, enrollment credit is applied on a strictly monthly basis and there is no lifetime maximum. Enrollments with non-null remaining lifetime credit will receive the lesser of the remaining monthly credit or the remaining lifetime credit. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal lifetimeRemainingCredit;

    public BigDecimal getLifetimeRemainingCredit() {
        return lifetimeRemainingCredit;
    }

    public void setLifetimeRemainingCredit(BigDecimal lifetimeRemainingCredit) {
        lifetimeRemainingCreditSpecified = true;
        this.lifetimeRemainingCredit = lifetimeRemainingCredit;
    }

    protected boolean lifetimeRemainingCreditSpecified;

    public boolean isLifetimeRemainingCreditSpecified() {
        return lifetimeRemainingCreditSpecified;
    }

    public void unsetLifetimeRemainingCredit() {
        lifetimeRemainingCredit = null;
        lifetimeRemainingCreditSpecified = false;
    }

    /**
     * Maximum number of orders the enrolled account is allowed to have open at one time. If null, then the Flexible Credit Program does not impose an order limit. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal maximumActiveOrders;

    public BigDecimal getMaximumActiveOrders() {
        return maximumActiveOrders;
    }

    public void setMaximumActiveOrders(BigDecimal maximumActiveOrders) {
        maximumActiveOrdersSpecified = true;
        this.maximumActiveOrders = maximumActiveOrders;
    }

    protected boolean maximumActiveOrdersSpecified;

    public boolean isMaximumActiveOrdersSpecified() {
        return maximumActiveOrdersSpecified;
    }

    public void unsetMaximumActiveOrders() {
        maximumActiveOrders = null;
        maximumActiveOrdersSpecified = 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;
    }

    /**
     * DEPRECATED: Taxes are calculated in real time and discount amounts are shown pre-tax in all cases. Tax values in the SoftLayer_Container_Account_Discount_Program container are now populated with the related pre-tax values. 
     */
    @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;
    }

    /**
     * Name of the Flexible Credit Program the account is enrolled in.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String programName;

    public String getProgramName() {
        return programName;
    }

    public void setProgramName(String programName) {
        programNameSpecified = true;
        this.programName = programName;
    }

    protected boolean programNameSpecified;

    public boolean isProgramNameSpecified() {
        return programNameSpecified;
    }

    public void unsetProgramName() {
        programName = null;
        programNameSpecified = false;
    }

    /**
     * The credit allowance that is available during the current billing cycle. If the lifetime limit has been or soon will be reached, this amount may be reduced by credit applied in previous billing cycles. 
     */
    @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;
    }

    /**
     * DEPRECATED: Taxes are calculated in real time and discount amounts are shown pre-tax in all cases. Tax values in the SoftLayer_Container_Account_Discount_Program container are now populated with the related pre-tax values. 
     */
    @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 lifetimeAppliedCredit() {
            withLocalProperty("lifetimeAppliedCredit");
            return this;
        }

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

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

        public Mask maximumActiveOrders() {
            withLocalProperty("maximumActiveOrders");
            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 programName() {
            withLocalProperty("programName");
            return this;
        }

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

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

    }

}