Package com.softlayer.api.service.container.account.discount

Class Program

java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.container.account.discount.Program
@ApiType("SoftLayer_Container_Account_Discount_Program")
public class Program
extends Entity
SoftLayer_Container_Account_Discount_Program models a single outbound object for a graph of given data sets.
See Also:
SoftLayer_Container_Account_Discount_Program

  • Field Details

    • appliedCredit

      @ApiProperty(canBeNullOrNotSet=true) protected BigDecimal appliedCredit
      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.

    • appliedCreditSpecified

      protected boolean appliedCreditSpecified

    • isParticipant

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

    • isParticipantSpecified

      protected boolean isParticipantSpecified

    • lifetimeAppliedCredit

      @ApiProperty(canBeNullOrNotSet=true) protected BigDecimal lifetimeAppliedCredit
      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.

    • lifetimeAppliedCreditSpecified

      protected boolean lifetimeAppliedCreditSpecified

    • lifetimeCredit

      @ApiProperty(canBeNullOrNotSet=true) protected BigDecimal lifetimeCredit
      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.

    • lifetimeCreditSpecified

      protected boolean lifetimeCreditSpecified

    • lifetimeRemainingCredit

      @ApiProperty(canBeNullOrNotSet=true) protected BigDecimal lifetimeRemainingCredit
      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.

    • lifetimeRemainingCreditSpecified

      protected boolean lifetimeRemainingCreditSpecified

    • maximumActiveOrders

      @ApiProperty(canBeNullOrNotSet=true) protected BigDecimal maximumActiveOrders
      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.

    • maximumActiveOrdersSpecified

      protected boolean maximumActiveOrdersSpecified

    • monthlyCredit

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

    • monthlyCreditSpecified

      protected boolean monthlyCreditSpecified

    • postTaxRemainingCredit

      @ApiProperty(canBeNullOrNotSet=true) protected BigDecimal postTaxRemainingCredit
      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.

    • postTaxRemainingCreditSpecified

      protected boolean postTaxRemainingCreditSpecified

    • programEndDate

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

    • programEndDateSpecified

      protected boolean programEndDateSpecified

    • programName

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

    • programNameSpecified

      protected boolean programNameSpecified

    • remainingCredit

      @ApiProperty(canBeNullOrNotSet=true) protected BigDecimal remainingCredit
      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.

    • remainingCreditSpecified

      protected boolean remainingCreditSpecified

    • remainingCreditTax

      @ApiProperty(canBeNullOrNotSet=true) protected BigDecimal remainingCreditTax
      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.

    • remainingCreditTaxSpecified

      protected boolean remainingCreditTaxSpecified

  • Constructor Details

    • Program

      public Program()

  • Method Details

    • getAppliedCredit

      public BigDecimal getAppliedCredit()

    • setAppliedCredit

      public void setAppliedCredit​(BigDecimal appliedCredit)

    • isAppliedCreditSpecified

      public boolean isAppliedCreditSpecified()

    • unsetAppliedCredit

      public void unsetAppliedCredit()

    • getIsParticipant

      public Boolean getIsParticipant()

    • setIsParticipant

      public void setIsParticipant​(Boolean isParticipant)

    • isIsParticipantSpecified

      public boolean isIsParticipantSpecified()

    • unsetIsParticipant

      public void unsetIsParticipant()

    • getLifetimeAppliedCredit

      public BigDecimal getLifetimeAppliedCredit()

    • setLifetimeAppliedCredit

      public void setLifetimeAppliedCredit​(BigDecimal lifetimeAppliedCredit)

    • isLifetimeAppliedCreditSpecified

      public boolean isLifetimeAppliedCreditSpecified()

    • unsetLifetimeAppliedCredit

      public void unsetLifetimeAppliedCredit()

    • getLifetimeCredit

      public BigDecimal getLifetimeCredit()

    • setLifetimeCredit

      public void setLifetimeCredit​(BigDecimal lifetimeCredit)

    • isLifetimeCreditSpecified

      public boolean isLifetimeCreditSpecified()

    • unsetLifetimeCredit

      public void unsetLifetimeCredit()

    • getLifetimeRemainingCredit

      public BigDecimal getLifetimeRemainingCredit()

    • setLifetimeRemainingCredit

      public void setLifetimeRemainingCredit​(BigDecimal lifetimeRemainingCredit)

    • isLifetimeRemainingCreditSpecified

      public boolean isLifetimeRemainingCreditSpecified()

    • unsetLifetimeRemainingCredit

      public void unsetLifetimeRemainingCredit()

    • getMaximumActiveOrders

      public BigDecimal getMaximumActiveOrders()

    • setMaximumActiveOrders

      public void setMaximumActiveOrders​(BigDecimal maximumActiveOrders)

    • isMaximumActiveOrdersSpecified

      public boolean isMaximumActiveOrdersSpecified()

    • unsetMaximumActiveOrders

      public void unsetMaximumActiveOrders()

    • getMonthlyCredit

      public BigDecimal getMonthlyCredit()

    • setMonthlyCredit

      public void setMonthlyCredit​(BigDecimal monthlyCredit)

    • isMonthlyCreditSpecified

      public boolean isMonthlyCreditSpecified()

    • unsetMonthlyCredit

      public void unsetMonthlyCredit()

    • getPostTaxRemainingCredit

      public BigDecimal getPostTaxRemainingCredit()

    • setPostTaxRemainingCredit

      public void setPostTaxRemainingCredit​(BigDecimal postTaxRemainingCredit)

    • isPostTaxRemainingCreditSpecified

      public boolean isPostTaxRemainingCreditSpecified()

    • unsetPostTaxRemainingCredit

      public void unsetPostTaxRemainingCredit()

    • getProgramEndDate

      public GregorianCalendar getProgramEndDate()

    • setProgramEndDate

      public void setProgramEndDate​(GregorianCalendar programEndDate)

    • isProgramEndDateSpecified

      public boolean isProgramEndDateSpecified()

    • unsetProgramEndDate

      public void unsetProgramEndDate()

    • getProgramName

      public String getProgramName()

    • setProgramName

      public void setProgramName​(String programName)

    • isProgramNameSpecified

      public boolean isProgramNameSpecified()

    • unsetProgramName

      public void unsetProgramName()

    • getRemainingCredit

      public BigDecimal getRemainingCredit()

    • setRemainingCredit

      public void setRemainingCredit​(BigDecimal remainingCredit)

    • isRemainingCreditSpecified

      public boolean isRemainingCreditSpecified()

    • unsetRemainingCredit

      public void unsetRemainingCredit()

    • getRemainingCreditTax

      public BigDecimal getRemainingCreditTax()

    • setRemainingCreditTax

      public void setRemainingCreditTax​(BigDecimal remainingCreditTax)

    • isRemainingCreditTaxSpecified

      public boolean isRemainingCreditTaxSpecified()

    • unsetRemainingCreditTax

      public void unsetRemainingCreditTax()