com.softlayer.api.service.flexiblecredit.Enrollment 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.flexiblecredit;

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 com.softlayer.api.service.flexiblecredit.Affiliate;
import com.softlayer.api.service.flexiblecredit.Program;
import com.softlayer.api.service.flexiblecredit.company.Type;
import com.softlayer.api.service.user.Employee;
import java.math.BigDecimal;
import java.util.GregorianCalendar;

/**
 * @see SoftLayer_FlexibleCredit_Enrollment
 */
@ApiType("SoftLayer_FlexibleCredit_Enrollment")
public class Enrollment extends Entity {

    /**
     * Account the enrollment belongs to
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

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

    /**
     * Affiliate associated with the account enrollment
     */
    @ApiProperty
    protected Affiliate affiliate;

    public Affiliate getAffiliate() {
        return affiliate;
    }

    public void setAffiliate(Affiliate affiliate) {
        this.affiliate = affiliate;
    }

    /**
     * Category which best describes the company
     */
    @ApiProperty
    protected Type companyType;

    public Type getCompanyType() {
        return companyType;
    }

    public void setCompanyType(Type companyType) {
        this.companyType = companyType;
    }

    /**
     * Discount program the enrollment belongs to
     */
    @ApiProperty
    protected Program flexibleCreditProgram;

    public Program getFlexibleCreditProgram() {
        return flexibleCreditProgram;
    }

    public void setFlexibleCreditProgram(Program flexibleCreditProgram) {
        this.flexibleCreditProgram = flexibleCreditProgram;
    }

    /**
     * Flag indicating whether an enrollment is active (true) or inactive (false)
     */
    @ApiProperty
    protected Boolean isActiveFlag;

    public Boolean getIsActiveFlag() {
        return isActiveFlag;
    }

    public void setIsActiveFlag(Boolean isActiveFlag) {
        this.isActiveFlag = isActiveFlag;
    }

    /**
     * Employee overseeing the enrollment
     */
    @ApiProperty
    protected Employee representative;

    public Employee getRepresentative() {
        return representative;
    }

    public void setRepresentative(Employee representative) {
        this.representative = representative;
    }

    /**
     * Account ID associated with this enrollment
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long accountId;

    public Long getAccountId() {
        return accountId;
    }

    public void setAccountId(Long accountId) {
        accountIdSpecified = true;
        this.accountId = accountId;
    }

    protected boolean accountIdSpecified;

    public boolean isAccountIdSpecified() {
        return accountIdSpecified;
    }

    public void unsetAccountId() {
        accountId = null;
        accountIdSpecified = false;
    }

    /**
     * ID of the corresponding Flexible Credit Program Affiliate
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long affiliateId;

    public Long getAffiliateId() {
        return affiliateId;
    }

    public void setAffiliateId(Long affiliateId) {
        affiliateIdSpecified = true;
        this.affiliateId = affiliateId;
    }

    protected boolean affiliateIdSpecified;

    public boolean isAffiliateIdSpecified() {
        return affiliateIdSpecified;
    }

    public void unsetAffiliateId() {
        affiliateId = null;
        affiliateIdSpecified = false;
    }

    /**
     * Indicates signing of Flexible Credit agreement (independent from MSA)
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long agreementCompleteFlag;

    public Long getAgreementCompleteFlag() {
        return agreementCompleteFlag;
    }

    public void setAgreementCompleteFlag(Long agreementCompleteFlag) {
        agreementCompleteFlagSpecified = true;
        this.agreementCompleteFlag = agreementCompleteFlag;
    }

    protected boolean agreementCompleteFlagSpecified;

    public boolean isAgreementCompleteFlagSpecified() {
        return agreementCompleteFlagSpecified;
    }

    public void unsetAgreementCompleteFlag() {
        agreementCompleteFlag = null;
        agreementCompleteFlagSpecified = false;
    }

    /**
     * Brief description of the company
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String companyDescription;

    public String getCompanyDescription() {
        return companyDescription;
    }

    public void setCompanyDescription(String companyDescription) {
        companyDescriptionSpecified = true;
        this.companyDescription = companyDescription;
    }

    protected boolean companyDescriptionSpecified;

    public boolean isCompanyDescriptionSpecified() {
        return companyDescriptionSpecified;
    }

    public void unsetCompanyDescription() {
        companyDescription = null;
        companyDescriptionSpecified = false;
    }

    /**
     * ID of the Flexible Credit Program Company classification for this enrollment
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long companyTypeId;

    public Long getCompanyTypeId() {
        return companyTypeId;
    }

    public void setCompanyTypeId(Long companyTypeId) {
        companyTypeIdSpecified = true;
        this.companyTypeId = companyTypeId;
    }

    protected boolean companyTypeIdSpecified;

    public boolean isCompanyTypeIdSpecified() {
        return companyTypeIdSpecified;
    }

    public void unsetCompanyTypeId() {
        companyTypeId = null;
        companyTypeIdSpecified = false;
    }

    /**
     * Date when participation in the Flexible Credit program began
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar enrollmentDate;

    public GregorianCalendar getEnrollmentDate() {
        return enrollmentDate;
    }

    public void setEnrollmentDate(GregorianCalendar enrollmentDate) {
        enrollmentDateSpecified = true;
        this.enrollmentDate = enrollmentDate;
    }

    protected boolean enrollmentDateSpecified;

    public boolean isEnrollmentDateSpecified() {
        return enrollmentDateSpecified;
    }

    public void unsetEnrollmentDate() {
        enrollmentDate = null;
        enrollmentDateSpecified = false;
    }

    /**
     * Date Flexible Credit Program benefits end.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar graduationDate;

    public GregorianCalendar getGraduationDate() {
        return graduationDate;
    }

    public void setGraduationDate(GregorianCalendar graduationDate) {
        graduationDateSpecified = true;
        this.graduationDate = graduationDate;
    }

    protected boolean graduationDateSpecified;

    public boolean isGraduationDateSpecified() {
        return graduationDateSpecified;
    }

    public void unsetGraduationDate() {
        graduationDate = null;
        graduationDateSpecified = false;
    }

    /**
     * Amount of monthly credit (USD) given to the account
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal monthlyCreditAmount;

    public BigDecimal getMonthlyCreditAmount() {
        return monthlyCreditAmount;
    }

    public void setMonthlyCreditAmount(BigDecimal monthlyCreditAmount) {
        monthlyCreditAmountSpecified = true;
        this.monthlyCreditAmount = monthlyCreditAmount;
    }

    protected boolean monthlyCreditAmountSpecified;

    public boolean isMonthlyCreditAmountSpecified() {
        return monthlyCreditAmountSpecified;
    }

    public void unsetMonthlyCreditAmount() {
        monthlyCreditAmount = null;
        monthlyCreditAmountSpecified = false;
    }

    /**
     * ID of the employee representing this account.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long representativeEmployeeId;

    public Long getRepresentativeEmployeeId() {
        return representativeEmployeeId;
    }

    public void setRepresentativeEmployeeId(Long representativeEmployeeId) {
        representativeEmployeeIdSpecified = true;
        this.representativeEmployeeId = representativeEmployeeId;
    }

    protected boolean representativeEmployeeIdSpecified;

    public boolean isRepresentativeEmployeeIdSpecified() {
        return representativeEmployeeIdSpecified;
    }

    public void unsetRepresentativeEmployeeId() {
        representativeEmployeeId = null;
        representativeEmployeeIdSpecified = 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 Affiliate.Mask affiliate() {
            return withSubMask("affiliate", Affiliate.Mask.class);
        }

        public com.softlayer.api.service.flexiblecredit.company.Type.Mask companyType() {
            return withSubMask("companyType", com.softlayer.api.service.flexiblecredit.company.Type.Mask.class);
        }

        public Program.Mask flexibleCreditProgram() {
            return withSubMask("flexibleCreditProgram", Program.Mask.class);
        }

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

        public com.softlayer.api.service.user.Employee.Mask representative() {
            return withSubMask("representative", com.softlayer.api.service.user.Employee.Mask.class);
        }

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

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

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

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

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

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

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

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

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

    }

}