com.softlayer.api.service.container.tax.Cache 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.tax;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.container.tax.cache.Item;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

/**
 * These are the results of a tax calculation. The tax calculation was kicked off but allowed to run in the background. This type stores the results so that an interface can be updated with up-to-date information. 
 *
 * @see SoftLayer_Container_Tax_Cache
 */
@ApiType("SoftLayer_Container_Tax_Cache")
public class Cache extends Entity {

    /**
     * The percentage of the final total that should be tax.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal effectiveTaxRate;

    public BigDecimal getEffectiveTaxRate() {
        return effectiveTaxRate;
    }

    public void setEffectiveTaxRate(BigDecimal effectiveTaxRate) {
        effectiveTaxRateSpecified = true;
        this.effectiveTaxRate = effectiveTaxRate;
    }

    protected boolean effectiveTaxRateSpecified;

    public boolean isEffectiveTaxRateSpecified() {
        return effectiveTaxRateSpecified;
    }

    public void unsetEffectiveTaxRate() {
        effectiveTaxRate = null;
        effectiveTaxRateSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected String failureMessage;

    public String getFailureMessage() {
        return failureMessage;
    }

    public void setFailureMessage(String failureMessage) {
        failureMessageSpecified = true;
        this.failureMessage = failureMessage;
    }

    protected boolean failureMessageSpecified;

    public boolean isFailureMessageSpecified() {
        return failureMessageSpecified;
    }

    public void unsetFailureMessage() {
        failureMessage = null;
        failureMessageSpecified = false;
    }

    /**
     * The container that holds the four actual tax rates, one for each fee type.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected List items;

    public List getItems() {
        if (items == null) {
            items = new ArrayList();
        }
        return items;
    }

    protected boolean itemsSpecified;

    public boolean isItemsSpecified() {
        return itemsSpecified;
    }

    public void unsetItems() {
        items = null;
        itemsSpecified = false;
    }

    /**
     * The status of the tax request. This should be PENDING, FAILED, or COMPLETED.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String status;

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        statusSpecified = true;
        this.status = status;
    }

    protected boolean statusSpecified;

    public boolean isStatusSpecified() {
        return statusSpecified;
    }

    public void unsetStatus() {
        status = null;
        statusSpecified = false;
    }

    /**
     * The final amount of tax for the order.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal totalTaxAmount;

    public BigDecimal getTotalTaxAmount() {
        return totalTaxAmount;
    }

    public void setTotalTaxAmount(BigDecimal totalTaxAmount) {
        totalTaxAmountSpecified = true;
        this.totalTaxAmount = totalTaxAmount;
    }

    protected boolean totalTaxAmountSpecified;

    public boolean isTotalTaxAmountSpecified() {
        return totalTaxAmountSpecified;
    }

    public void unsetTotalTaxAmount() {
        totalTaxAmount = null;
        totalTaxAmountSpecified = false;
    }

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

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

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

        public com.softlayer.api.service.container.tax.cache.Item.Mask items() {
            return withSubMask("items", com.softlayer.api.service.container.tax.cache.Item.Mask.class);
        }

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

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

    }

}