All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.softlayer.api.service.billing.order.Item Maven / Gradle / Ivy

Go to download

API client for accessing the SoftLayer API

The newest version!
package com.softlayer.api.service.billing.order;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Location;
import com.softlayer.api.service.billing.order.item.category.Answer;
import com.softlayer.api.service.configuration.storage.group.Order;
import com.softlayer.api.service.hardware.component.model.Generic;
import com.softlayer.api.service.product.Package;
import com.softlayer.api.service.product.Promotion;
import com.softlayer.api.service.product.item.Category;
import com.softlayer.api.service.product.item.Price;
import com.softlayer.api.service.product.pkg.Preset;
import com.softlayer.api.service.software.Description;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * Every individual item that a SoftLayer customer is billed for is recorded in the SoftLayer_Billing_Item data type. Billing items range from server chassis to hard drives to control panels, bandwidth quota upgrades and port upgrade charges. SoftLayer [[SoftLayer_Billing_Invoice|invoices]] are generated from the cost of a customer's billing items. Billing items are copied from the product catalog as they're ordered by customers to create a reference between an account and the billable items they own. 

 * 

 * Billing items exist in a tree relationship. Items are associated with each other by parent/child relationships. Component items such as CPU's, RAM, and software each have a parent billing item for the server chassis they're associated with. Billing Items with a null parent item do not have an associated parent item. 
 *
 * @see SoftLayer_Billing_Order_Item
 */
@ApiType("SoftLayer_Billing_Order_Item")
public class Item extends Entity {

    /**
     * The SoftLayer_Billing_Item tied to the order item.
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.Item billingItem;

    public com.softlayer.api.service.billing.Item getBillingItem() {
        return billingItem;
    }

    public void setBillingItem(com.softlayer.api.service.billing.Item billingItem) {
        this.billingItem = billingItem;
    }

    /**
     * The other items included with an ordered item.
     */
    @ApiProperty
    protected List bundledItems;

    public List getBundledItems() {
        if (bundledItems == null) {
            bundledItems = new ArrayList();
        }
        return bundledItems;
    }

    /**
     * The item category tied to an order item.
     */
    @ApiProperty
    protected Category category;

    public Category getCategory() {
        return category;
    }

    public void setCategory(Category category) {
        this.category = category;
    }

    /**
     * The child order items for an order item. All server order items should have children. These children are considered a part of the server.
     */
    @ApiProperty
    protected List children;

    public List getChildren() {
        if (children == null) {
            children = new ArrayList();
        }
        return children;
    }

    /**
     * A hardware's universally unique identifier.
     */
    @ApiProperty
    protected String globalIdentifier;

    public String getGlobalIdentifier() {
        return globalIdentifier;
    }

    public void setGlobalIdentifier(String globalIdentifier) {
        this.globalIdentifier = globalIdentifier;
    }

    /**
     * The component type tied to an order item. All hardware-specific items should have a generic hardware component.
     */
    @ApiProperty
    protected Generic hardwareGenericComponent;

    public Generic getHardwareGenericComponent() {
        return hardwareGenericComponent;
    }

    public void setHardwareGenericComponent(Generic hardwareGenericComponent) {
        this.hardwareGenericComponent = hardwareGenericComponent;
    }

    /**
     * The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.
     */
    @ApiProperty
    protected com.softlayer.api.service.product.Item item;

    public com.softlayer.api.service.product.Item getItem() {
        return item;
    }

    public void setItem(com.softlayer.api.service.product.Item item) {
        this.item = item;
    }

    /**
     * This is an item's category answers.
     */
    @ApiProperty
    protected List itemCategoryAnswers;

    public List getItemCategoryAnswers() {
        if (itemCategoryAnswers == null) {
            itemCategoryAnswers = new ArrayList();
        }
        return itemCategoryAnswers;
    }

    /**
     * The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.
     */
    @ApiProperty
    protected Price itemPrice;

    public Price getItemPrice() {
        return itemPrice;
    }

    public void setItemPrice(Price itemPrice) {
        this.itemPrice = itemPrice;
    }

    /**
     * The location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered.
     */
    @ApiProperty
    protected Location location;

    public Location getLocation() {
        return location;
    }

    public void setLocation(Location location) {
        this.location = location;
    }

    @ApiProperty
    protected List nextOrderChildren;

    public List getNextOrderChildren() {
        if (nextOrderChildren == null) {
            nextOrderChildren = new ArrayList();
        }
        return nextOrderChildren;
    }

    /**
     * This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened.
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.Item oldBillingItem;

    public com.softlayer.api.service.billing.Item getOldBillingItem() {
        return oldBillingItem;
    }

    public void setOldBillingItem(com.softlayer.api.service.billing.Item oldBillingItem) {
        this.oldBillingItem = oldBillingItem;
    }

    /**
     * The order to which this item belongs. The order contains all the information related to the items included in an order
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.Order order;

    public com.softlayer.api.service.billing.Order getOrder() {
        return order;
    }

    public void setOrder(com.softlayer.api.service.billing.Order order) {
        this.order = order;
    }

    @ApiProperty
    protected GregorianCalendar orderApprovalDate;

    public GregorianCalendar getOrderApprovalDate() {
        return orderApprovalDate;
    }

    public void setOrderApprovalDate(GregorianCalendar orderApprovalDate) {
        this.orderApprovalDate = orderApprovalDate;
    }

    /**
     * The SoftLayer_Product_Package an order item is a part of.
     */
    @ApiProperty("package")
    protected Package itemPackage;

    public Package getItemPackage() {
        return itemPackage;
    }

    public void setItemPackage(Package itemPackage) {
        this.itemPackage = itemPackage;
    }

    /**
     * The parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself.
     */
    @ApiProperty
    protected Item parent;

    public Item getParent() {
        return parent;
    }

    public void setParent(Item parent) {
        this.parent = parent;
    }

    /**
     * The SoftLayer_Product_Package_Preset related to this order item.
     */
    @ApiProperty
    protected Preset preset;

    public Preset getPreset() {
        return preset;
    }

    public void setPreset(Preset preset) {
        this.preset = preset;
    }

    @ApiProperty
    protected Promotion promoCode;

    public Promotion getPromoCode() {
        return promoCode;
    }

    public void setPromoCode(Promotion promoCode) {
        this.promoCode = promoCode;
    }

    /**
     * A count of power supplies contained within this SoftLayer_Billing_Order
     */
    @ApiProperty
    protected Long redundantPowerSupplyCount;

    public Long getRedundantPowerSupplyCount() {
        return redundantPowerSupplyCount;
    }

    public void setRedundantPowerSupplyCount(Long redundantPowerSupplyCount) {
        this.redundantPowerSupplyCount = redundantPowerSupplyCount;
    }

    /**
     * For ordered items that are software items, a full description of that software can be found with this property. 
     */
    @ApiProperty
    protected Description softwareDescription;

    public Description getSoftwareDescription() {
        return softwareDescription;
    }

    public void setSoftwareDescription(Description softwareDescription) {
        this.softwareDescription = softwareDescription;
    }

    /**
     * The drive storage groups that are attached to this billing order item.
     */
    @ApiProperty
    protected List storageGroups;

    public List getStorageGroups() {
        if (storageGroups == null) {
            storageGroups = new ArrayList();
        }
        return storageGroups;
    }

    /**
     * The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
     */
    @ApiProperty
    protected BigDecimal totalRecurringAmount;

    public BigDecimal getTotalRecurringAmount() {
        return totalRecurringAmount;
    }

    public void setTotalRecurringAmount(BigDecimal totalRecurringAmount) {
        this.totalRecurringAmount = totalRecurringAmount;
    }

    /**
     * The next SoftLayer_Product_Item in the upgrade path for this order item.
     */
    @ApiProperty
    protected com.softlayer.api.service.product.Item upgradeItem;

    public com.softlayer.api.service.product.Item getUpgradeItem() {
        return upgradeItem;
    }

    public void setUpgradeItem(com.softlayer.api.service.product.Item upgradeItem) {
        this.upgradeItem = upgradeItem;
    }

    /**
     * The category code for the order item.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String categoryCode;

    public String getCategoryCode() {
        return categoryCode;
    }

    public void setCategoryCode(String categoryCode) {
        categoryCodeSpecified = true;
        this.categoryCode = categoryCode;
    }

    protected boolean categoryCodeSpecified;

    public boolean isCategoryCodeSpecified() {
        return categoryCodeSpecified;
    }

    public void unsetCategoryCode() {
        categoryCode = null;
        categoryCodeSpecified = false;
    }

    /**
     * friendly description of purchase item.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String description;

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        descriptionSpecified = true;
        this.description = description;
    }

    protected boolean descriptionSpecified;

    public boolean isDescriptionSpecified() {
        return descriptionSpecified;
    }

    public void unsetDescription() {
        description = null;
        descriptionSpecified = false;
    }

    /**
     * The domain name of the server as designated by the purchaser at the time of order placement.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String domainName;

    public String getDomainName() {
        return domainName;
    }

    public void setDomainName(String domainName) {
        domainNameSpecified = true;
        this.domainName = domainName;
    }

    protected boolean domainNameSpecified;

    public boolean isDomainNameSpecified() {
        return domainNameSpecified;
    }

    public void unsetDomainName() {
        domainName = null;
        domainNameSpecified = false;
    }

    /**
     * The hostname of the server as designated by the purchaser at the time of order placement.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String hostName;

    public String getHostName() {
        return hostName;
    }

    public void setHostName(String hostName) {
        hostNameSpecified = true;
        this.hostName = hostName;
    }

    protected boolean hostNameSpecified;

    public boolean isHostNameSpecified() {
        return hostNameSpecified;
    }

    public void unsetHostName() {
        hostName = null;
        hostNameSpecified = false;
    }

    /**
     * The amount of money charged per hourly for an order item, if applicable, and only if it was ordered this day. hourlyRecurringFee is measured in US Dollars ($USD). 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal hourlyRecurringFee;

    public BigDecimal getHourlyRecurringFee() {
        return hourlyRecurringFee;
    }

    public void setHourlyRecurringFee(BigDecimal hourlyRecurringFee) {
        hourlyRecurringFeeSpecified = true;
        this.hourlyRecurringFee = hourlyRecurringFee;
    }

    protected boolean hourlyRecurringFeeSpecified;

    public boolean isHourlyRecurringFeeSpecified() {
        return hourlyRecurringFeeSpecified;
    }

    public void unsetHourlyRecurringFee() {
        hourlyRecurringFee = null;
        hourlyRecurringFeeSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * The SoftLayer_Product_Item ID for this order item.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long itemId;

    public Long getItemId() {
        return itemId;
    }

    public void setItemId(Long itemId) {
        itemIdSpecified = true;
        this.itemId = itemId;
    }

    protected boolean itemIdSpecified;

    public boolean isItemIdSpecified() {
        return itemIdSpecified;
    }

    public void unsetItemId() {
        itemId = null;
        itemIdSpecified = false;
    }

    /**
     * the item price id (SoftLayer_Product_Item_Price->id) of the ordered item.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal itemPriceId;

    public BigDecimal getItemPriceId() {
        return itemPriceId;
    }

    public void setItemPriceId(BigDecimal itemPriceId) {
        itemPriceIdSpecified = true;
        this.itemPriceId = itemPriceId;
    }

    protected boolean itemPriceIdSpecified;

    public boolean isItemPriceIdSpecified() {
        return itemPriceIdSpecified;
    }

    public void unsetItemPriceId() {
        itemPriceId = null;
        itemPriceIdSpecified = false;
    }

    /**
     * An order item's labor fee total after taxes. This does not include any child invoice items.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal laborAfterTaxAmount;

    public BigDecimal getLaborAfterTaxAmount() {
        return laborAfterTaxAmount;
    }

    public void setLaborAfterTaxAmount(BigDecimal laborAfterTaxAmount) {
        laborAfterTaxAmountSpecified = true;
        this.laborAfterTaxAmount = laborAfterTaxAmount;
    }

    protected boolean laborAfterTaxAmountSpecified;

    public boolean isLaborAfterTaxAmountSpecified() {
        return laborAfterTaxAmountSpecified;
    }

    public void unsetLaborAfterTaxAmount() {
        laborAfterTaxAmount = null;
        laborAfterTaxAmountSpecified = false;
    }

    /**
     * The labor fee, if any. This is a one time charge.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal laborFee;

    public BigDecimal getLaborFee() {
        return laborFee;
    }

    public void setLaborFee(BigDecimal laborFee) {
        laborFeeSpecified = true;
        this.laborFee = laborFee;
    }

    protected boolean laborFeeSpecified;

    public boolean isLaborFeeSpecified() {
        return laborFeeSpecified;
    }

    public void unsetLaborFee() {
        laborFee = null;
        laborFeeSpecified = false;
    }

    /**
     * The rate at which labor fees are taxed if you are a taxable customer.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal laborFeeTaxRate;

    public BigDecimal getLaborFeeTaxRate() {
        return laborFeeTaxRate;
    }

    public void setLaborFeeTaxRate(BigDecimal laborFeeTaxRate) {
        laborFeeTaxRateSpecified = true;
        this.laborFeeTaxRate = laborFeeTaxRate;
    }

    protected boolean laborFeeTaxRateSpecified;

    public boolean isLaborFeeTaxRateSpecified() {
        return laborFeeTaxRateSpecified;
    }

    public void unsetLaborFeeTaxRate() {
        laborFeeTaxRate = null;
        laborFeeTaxRateSpecified = false;
    }

    /**
     * An order item's labor tax amount. This does not include any child invoice items.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal laborTaxAmount;

    public BigDecimal getLaborTaxAmount() {
        return laborTaxAmount;
    }

    public void setLaborTaxAmount(BigDecimal laborTaxAmount) {
        laborTaxAmountSpecified = true;
        this.laborTaxAmount = laborTaxAmount;
    }

    protected boolean laborTaxAmountSpecified;

    public boolean isLaborTaxAmountSpecified() {
        return laborTaxAmountSpecified;
    }

    public void unsetLaborTaxAmount() {
        laborTaxAmount = null;
        laborTaxAmountSpecified = false;
    }

    /**
     * An order item's one-time fee total after taxes. This does not include any child invoice items.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal oneTimeAfterTaxAmount;

    public BigDecimal getOneTimeAfterTaxAmount() {
        return oneTimeAfterTaxAmount;
    }

    public void setOneTimeAfterTaxAmount(BigDecimal oneTimeAfterTaxAmount) {
        oneTimeAfterTaxAmountSpecified = true;
        this.oneTimeAfterTaxAmount = oneTimeAfterTaxAmount;
    }

    protected boolean oneTimeAfterTaxAmountSpecified;

    public boolean isOneTimeAfterTaxAmountSpecified() {
        return oneTimeAfterTaxAmountSpecified;
    }

    public void unsetOneTimeAfterTaxAmount() {
        oneTimeAfterTaxAmount = null;
        oneTimeAfterTaxAmountSpecified = false;
    }

    /**
     * The amount of money charged as a one-time charge for an order item, if applicable. oneTimeFee is measured in US Dollars ($USD). 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal oneTimeFee;

    public BigDecimal getOneTimeFee() {
        return oneTimeFee;
    }

    public void setOneTimeFee(BigDecimal oneTimeFee) {
        oneTimeFeeSpecified = true;
        this.oneTimeFee = oneTimeFee;
    }

    protected boolean oneTimeFeeSpecified;

    public boolean isOneTimeFeeSpecified() {
        return oneTimeFeeSpecified;
    }

    public void unsetOneTimeFee() {
        oneTimeFee = null;
        oneTimeFeeSpecified = false;
    }

    /**
     * The rate at which one time fees are taxed if you are a taxable customer.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal oneTimeFeeTaxRate;

    public BigDecimal getOneTimeFeeTaxRate() {
        return oneTimeFeeTaxRate;
    }

    public void setOneTimeFeeTaxRate(BigDecimal oneTimeFeeTaxRate) {
        oneTimeFeeTaxRateSpecified = true;
        this.oneTimeFeeTaxRate = oneTimeFeeTaxRate;
    }

    protected boolean oneTimeFeeTaxRateSpecified;

    public boolean isOneTimeFeeTaxRateSpecified() {
        return oneTimeFeeTaxRateSpecified;
    }

    public void unsetOneTimeFeeTaxRate() {
        oneTimeFeeTaxRate = null;
        oneTimeFeeTaxRateSpecified = false;
    }

    /**
     * An order item's one-time tax amount. This does not include any child invoice items.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal oneTimeTaxAmount;

    public BigDecimal getOneTimeTaxAmount() {
        return oneTimeTaxAmount;
    }

    public void setOneTimeTaxAmount(BigDecimal oneTimeTaxAmount) {
        oneTimeTaxAmountSpecified = true;
        this.oneTimeTaxAmount = oneTimeTaxAmount;
    }

    protected boolean oneTimeTaxAmountSpecified;

    public boolean isOneTimeTaxAmountSpecified() {
        return oneTimeTaxAmountSpecified;
    }

    public void unsetOneTimeTaxAmount() {
        oneTimeTaxAmount = null;
        oneTimeTaxAmountSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected Long parentId;

    public Long getParentId() {
        return parentId;
    }

    public void setParentId(Long parentId) {
        parentIdSpecified = true;
        this.parentId = parentId;
    }

    protected boolean parentIdSpecified;

    public boolean isParentIdSpecified() {
        return parentIdSpecified;
    }

    public void unsetParentId() {
        parentId = null;
        parentIdSpecified = false;
    }

    /**
     * The id for the preset configuration ordered.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long presetId;

    public Long getPresetId() {
        return presetId;
    }

    public void setPresetId(Long presetId) {
        presetIdSpecified = true;
        this.presetId = presetId;
    }

    protected boolean presetIdSpecified;

    public boolean isPresetIdSpecified() {
        return presetIdSpecified;
    }

    public void unsetPresetId() {
        presetId = null;
        presetIdSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected Long promoCodeId;

    public Long getPromoCodeId() {
        return promoCodeId;
    }

    public void setPromoCodeId(Long promoCodeId) {
        promoCodeIdSpecified = true;
        this.promoCodeId = promoCodeId;
    }

    protected boolean promoCodeIdSpecified;

    public boolean isPromoCodeIdSpecified() {
        return promoCodeIdSpecified;
    }

    public void unsetPromoCodeId() {
        promoCodeId = null;
        promoCodeIdSpecified = false;
    }

    /**
     * the quantity of the ordered item in a quote.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long quantity;

    public Long getQuantity() {
        return quantity;
    }

    public void setQuantity(Long quantity) {
        quantitySpecified = true;
        this.quantity = quantity;
    }

    protected boolean quantitySpecified;

    public boolean isQuantitySpecified() {
        return quantitySpecified;
    }

    public void unsetQuantity() {
        quantity = null;
        quantitySpecified = false;
    }

    /**
     * An order item's recurring fee total after taxes. This does not include any child invoice items.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal recurringAfterTaxAmount;

    public BigDecimal getRecurringAfterTaxAmount() {
        return recurringAfterTaxAmount;
    }

    public void setRecurringAfterTaxAmount(BigDecimal recurringAfterTaxAmount) {
        recurringAfterTaxAmountSpecified = true;
        this.recurringAfterTaxAmount = recurringAfterTaxAmount;
    }

    protected boolean recurringAfterTaxAmountSpecified;

    public boolean isRecurringAfterTaxAmountSpecified() {
        return recurringAfterTaxAmountSpecified;
    }

    public void unsetRecurringAfterTaxAmount() {
        recurringAfterTaxAmount = null;
        recurringAfterTaxAmountSpecified = false;
    }

    /**
     * The amount of money charged per month for an order item, if applicable. recurringFee is measured in US Dollars ($USD). 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal recurringFee;

    public BigDecimal getRecurringFee() {
        return recurringFee;
    }

    public void setRecurringFee(BigDecimal recurringFee) {
        recurringFeeSpecified = true;
        this.recurringFee = recurringFee;
    }

    protected boolean recurringFeeSpecified;

    public boolean isRecurringFeeSpecified() {
        return recurringFeeSpecified;
    }

    public void unsetRecurringFee() {
        recurringFee = null;
        recurringFeeSpecified = false;
    }

    /**
     * An order item's recurring tax amount. This does not include any child invoice items.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal recurringTaxAmount;

    public BigDecimal getRecurringTaxAmount() {
        return recurringTaxAmount;
    }

    public void setRecurringTaxAmount(BigDecimal recurringTaxAmount) {
        recurringTaxAmountSpecified = true;
        this.recurringTaxAmount = recurringTaxAmount;
    }

    protected boolean recurringTaxAmountSpecified;

    public boolean isRecurringTaxAmountSpecified() {
        return recurringTaxAmountSpecified;
    }

    public void unsetRecurringTaxAmount() {
        recurringTaxAmount = null;
        recurringTaxAmountSpecified = false;
    }

    /**
     * An order item's setup fee total after taxes. This does not include any child invoice items.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal setupAfterTaxAmount;

    public BigDecimal getSetupAfterTaxAmount() {
        return setupAfterTaxAmount;
    }

    public void setSetupAfterTaxAmount(BigDecimal setupAfterTaxAmount) {
        setupAfterTaxAmountSpecified = true;
        this.setupAfterTaxAmount = setupAfterTaxAmount;
    }

    protected boolean setupAfterTaxAmountSpecified;

    public boolean isSetupAfterTaxAmountSpecified() {
        return setupAfterTaxAmountSpecified;
    }

    public void unsetSetupAfterTaxAmount() {
        setupAfterTaxAmount = null;
        setupAfterTaxAmountSpecified = false;
    }

    /**
     * The setup fee, if any. This is a one time charge.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal setupFee;

    public BigDecimal getSetupFee() {
        return setupFee;
    }

    public void setSetupFee(BigDecimal setupFee) {
        setupFeeSpecified = true;
        this.setupFee = setupFee;
    }

    protected boolean setupFeeSpecified;

    public boolean isSetupFeeSpecified() {
        return setupFeeSpecified;
    }

    public void unsetSetupFee() {
        setupFee = null;
        setupFeeSpecified = false;
    }

    /**
     * The month set up fee deferral.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long setupFeeDeferralMonths;

    public Long getSetupFeeDeferralMonths() {
        return setupFeeDeferralMonths;
    }

    public void setSetupFeeDeferralMonths(Long setupFeeDeferralMonths) {
        setupFeeDeferralMonthsSpecified = true;
        this.setupFeeDeferralMonths = setupFeeDeferralMonths;
    }

    protected boolean setupFeeDeferralMonthsSpecified;

    public boolean isSetupFeeDeferralMonthsSpecified() {
        return setupFeeDeferralMonthsSpecified;
    }

    public void unsetSetupFeeDeferralMonths() {
        setupFeeDeferralMonths = null;
        setupFeeDeferralMonthsSpecified = false;
    }

    /**
     * The rate at which setup fees are taxed if you are a taxable customer.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal setupFeeTaxRate;

    public BigDecimal getSetupFeeTaxRate() {
        return setupFeeTaxRate;
    }

    public void setSetupFeeTaxRate(BigDecimal setupFeeTaxRate) {
        setupFeeTaxRateSpecified = true;
        this.setupFeeTaxRate = setupFeeTaxRate;
    }

    protected boolean setupFeeTaxRateSpecified;

    public boolean isSetupFeeTaxRateSpecified() {
        return setupFeeTaxRateSpecified;
    }

    public void unsetSetupFeeTaxRate() {
        setupFeeTaxRate = null;
        setupFeeTaxRateSpecified = false;
    }

    /**
     * An order item's setup tax amount. This does not include any child invoice items.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal setupTaxAmount;

    public BigDecimal getSetupTaxAmount() {
        return setupTaxAmount;
    }

    public void setSetupTaxAmount(BigDecimal setupTaxAmount) {
        setupTaxAmountSpecified = true;
        this.setupTaxAmount = setupTaxAmount;
    }

    protected boolean setupTaxAmountSpecified;

    public boolean isSetupTaxAmountSpecified() {
        return setupTaxAmountSpecified;
    }

    public void unsetSetupTaxAmount() {
        setupTaxAmount = null;
        setupTaxAmountSpecified = false;
    }

    /**
     * A count of the other items included with an ordered item.
     */
    @ApiProperty
    protected Long bundledItemCount;

    public Long getBundledItemCount() {
        return bundledItemCount;
    }

    public void setBundledItemCount(Long bundledItemCount) {
        this.bundledItemCount = bundledItemCount;
    }

    /**
     * A count of the child order items for an order item. All server order items should have children. These children are considered a part of the server.
     */
    @ApiProperty
    protected Long childrenCount;

    public Long getChildrenCount() {
        return childrenCount;
    }

    public void setChildrenCount(Long childrenCount) {
        this.childrenCount = childrenCount;
    }

    /**
     * A count of this is an item's category answers.
     */
    @ApiProperty
    protected Long itemCategoryAnswerCount;

    public Long getItemCategoryAnswerCount() {
        return itemCategoryAnswerCount;
    }

    public void setItemCategoryAnswerCount(Long itemCategoryAnswerCount) {
        this.itemCategoryAnswerCount = itemCategoryAnswerCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long nextOrderChildrenCount;

    public Long getNextOrderChildrenCount() {
        return nextOrderChildrenCount;
    }

    public void setNextOrderChildrenCount(Long nextOrderChildrenCount) {
        this.nextOrderChildrenCount = nextOrderChildrenCount;
    }

    /**
     * A count of the drive storage groups that are attached to this billing order item.
     */
    @ApiProperty
    protected Long storageGroupCount;

    public Long getStorageGroupCount() {
        return storageGroupCount;
    }

    public void setStorageGroupCount(Long storageGroupCount) {
        this.storageGroupCount = storageGroupCount;
    }

    public Service asService(ApiClient client) {
        if (id != null) {
            return service(client, id);
        } else {
            return service(client, globalIdentifier);
        }
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    public static Service service(ApiClient client, String globalIdentifier) {
        return client.createService(Service.class, globalIdentifier);
    }

    /**
     * The SoftLayer_Billing_Order_Item datatype provides information regarding a single ordered item. When a server order or any other order is placed, the information about that order is stored as SoftLayer_Billing_Order_items. 

     * 

     * This also provides information about software or hardware related to an ordered item,what package the item is in, and all pricing information related to this ordered item. 
     *
     * @see SoftLayer_Billing_Order_Item
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Billing_Order_Item")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are "parent" billing items and "child" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered "child" billing items. 
         *
         * @see SoftLayer_Billing_Order_Item::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Item getObject();

        /**
         * The SoftLayer_Billing_Item tied to the order item.
         *
         * @see SoftLayer_Billing_Order_Item::getBillingItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.billing.Item getBillingItem();

        /**
         * The other items included with an ordered item.
         *
         * @see SoftLayer_Billing_Order_Item::getBundledItems
         */
        @ApiMethod(instanceRequired = true)
        public List getBundledItems();

        /**
         * The item category tied to an order item.
         *
         * @see SoftLayer_Billing_Order_Item::getCategory
         */
        @ApiMethod(instanceRequired = true)
        public Category getCategory();

        /**
         * The child order items for an order item. All server order items should have children. These children are considered a part of the server.
         *
         * @see SoftLayer_Billing_Order_Item::getChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getChildren();

        /**
         * A hardware's universally unique identifier.
         *
         * @see SoftLayer_Billing_Order_Item::getGlobalIdentifier
         */
        @ApiMethod(instanceRequired = true)
        public String getGlobalIdentifier();

        /**
         * The component type tied to an order item. All hardware-specific items should have a generic hardware component.
         *
         * @see SoftLayer_Billing_Order_Item::getHardwareGenericComponent
         */
        @ApiMethod(instanceRequired = true)
        public Generic getHardwareGenericComponent();

        /**
         * The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.
         *
         * @see SoftLayer_Billing_Order_Item::getItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.product.Item getItem();

        /**
         * This is an item's category answers.
         *
         * @see SoftLayer_Billing_Order_Item::getItemCategoryAnswers
         */
        @ApiMethod(instanceRequired = true)
        public List getItemCategoryAnswers();

        /**
         * The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.
         *
         * @see SoftLayer_Billing_Order_Item::getItemPrice
         */
        @ApiMethod(instanceRequired = true)
        public Price getItemPrice();

        /**
         * The location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered.
         *
         * @see SoftLayer_Billing_Order_Item::getLocation
         */
        @ApiMethod(instanceRequired = true)
        public Location getLocation();

        /**
         * @see SoftLayer_Billing_Order_Item::getNextOrderChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getNextOrderChildren();

        /**
         * This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened.
         *
         * @see SoftLayer_Billing_Order_Item::getOldBillingItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.billing.Item getOldBillingItem();

        /**
         * The order to which this item belongs. The order contains all the information related to the items included in an order
         *
         * @see SoftLayer_Billing_Order_Item::getOrder
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.billing.Order getOrder();

        /**
         * @see SoftLayer_Billing_Order_Item::getOrderApprovalDate
         */
        @ApiMethod(instanceRequired = true)
        public GregorianCalendar getOrderApprovalDate();

        /**
         * The SoftLayer_Product_Package an order item is a part of.
         *
         * @see SoftLayer_Billing_Order_Item::getItemPackage
         */
        @ApiMethod(instanceRequired = true)
        public Package getItemPackage();

        /**
         * The parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself.
         *
         * @see SoftLayer_Billing_Order_Item::getParent
         */
        @ApiMethod(instanceRequired = true)
        public Item getParent();

        /**
         * The SoftLayer_Product_Package_Preset related to this order item.
         *
         * @see SoftLayer_Billing_Order_Item::getPreset
         */
        @ApiMethod(instanceRequired = true)
        public Preset getPreset();

        /**
         * @see SoftLayer_Billing_Order_Item::getPromoCode
         */
        @ApiMethod(instanceRequired = true)
        public Promotion getPromoCode();

        /**
         * A count of power supplies contained within this SoftLayer_Billing_Order
         *
         * @see SoftLayer_Billing_Order_Item::getRedundantPowerSupplyCount
         */
        @ApiMethod(instanceRequired = true)
        public Long getRedundantPowerSupplyCount();

        /**
         * For ordered items that are software items, a full description of that software can be found with this property. 
         *
         * @see SoftLayer_Billing_Order_Item::getSoftwareDescription
         */
        @ApiMethod(instanceRequired = true)
        public Description getSoftwareDescription();

        /**
         * The drive storage groups that are attached to this billing order item.
         *
         * @see SoftLayer_Billing_Order_Item::getStorageGroups
         */
        @ApiMethod(instanceRequired = true)
        public List getStorageGroups();

        /**
         * The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
         *
         * @see SoftLayer_Billing_Order_Item::getTotalRecurringAmount
         */
        @ApiMethod(instanceRequired = true)
        public BigDecimal getTotalRecurringAmount();

        /**
         * The next SoftLayer_Product_Item in the upgrade path for this order item.
         *
         * @see SoftLayer_Billing_Order_Item::getUpgradeItem
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.product.Item getUpgradeItem();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#getBillingItem}
         */
        public Future getBillingItem();

        /**
         * Async callback version of {@link Service#getBillingItem}
         */
        public Future getBillingItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getBundledItems}
         */
        public Future> getBundledItems();

        /**
         * Async callback version of {@link Service#getBundledItems}
         */
        public Future getBundledItems(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getCategory}
         */
        public Future getCategory();

        /**
         * Async callback version of {@link Service#getCategory}
         */
        public Future getCategory(ResponseHandler callback);

        /**
         * Async version of {@link Service#getChildren}
         */
        public Future> getChildren();

        /**
         * Async callback version of {@link Service#getChildren}
         */
        public Future getChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getGlobalIdentifier}
         */
        public Future getGlobalIdentifier();

        /**
         * Async callback version of {@link Service#getGlobalIdentifier}
         */
        public Future getGlobalIdentifier(ResponseHandler callback);

        /**
         * Async version of {@link Service#getHardwareGenericComponent}
         */
        public Future getHardwareGenericComponent();

        /**
         * Async callback version of {@link Service#getHardwareGenericComponent}
         */
        public Future getHardwareGenericComponent(ResponseHandler callback);

        /**
         * Async version of {@link Service#getItem}
         */
        public Future getItem();

        /**
         * Async callback version of {@link Service#getItem}
         */
        public Future getItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getItemCategoryAnswers}
         */
        public Future> getItemCategoryAnswers();

        /**
         * Async callback version of {@link Service#getItemCategoryAnswers}
         */
        public Future getItemCategoryAnswers(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getItemPrice}
         */
        public Future getItemPrice();

        /**
         * Async callback version of {@link Service#getItemPrice}
         */
        public Future getItemPrice(ResponseHandler callback);

        /**
         * Async version of {@link Service#getLocation}
         */
        public Future getLocation();

        /**
         * Async callback version of {@link Service#getLocation}
         */
        public Future getLocation(ResponseHandler callback);

        /**
         * Async version of {@link Service#getNextOrderChildren}
         */
        public Future> getNextOrderChildren();

        /**
         * Async callback version of {@link Service#getNextOrderChildren}
         */
        public Future getNextOrderChildren(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getOldBillingItem}
         */
        public Future getOldBillingItem();

        /**
         * Async callback version of {@link Service#getOldBillingItem}
         */
        public Future getOldBillingItem(ResponseHandler callback);

        /**
         * Async version of {@link Service#getOrder}
         */
        public Future getOrder();

        /**
         * Async callback version of {@link Service#getOrder}
         */
        public Future getOrder(ResponseHandler callback);

        /**
         * Async version of {@link Service#getOrderApprovalDate}
         */
        public Future getOrderApprovalDate();

        /**
         * Async callback version of {@link Service#getOrderApprovalDate}
         */
        public Future getOrderApprovalDate(ResponseHandler callback);

        /**
         * Async version of {@link Service#getItemPackage}
         */
        public Future getItemPackage();

        /**
         * Async callback version of {@link Service#getItemPackage}
         */
        public Future getItemPackage(ResponseHandler callback);

        /**
         * Async version of {@link Service#getParent}
         */
        public Future getParent();

        /**
         * Async callback version of {@link Service#getParent}
         */
        public Future getParent(ResponseHandler callback);

        /**
         * Async version of {@link Service#getPreset}
         */
        public Future getPreset();

        /**
         * Async callback version of {@link Service#getPreset}
         */
        public Future getPreset(ResponseHandler callback);

        /**
         * Async version of {@link Service#getPromoCode}
         */
        public Future getPromoCode();

        /**
         * Async callback version of {@link Service#getPromoCode}
         */
        public Future getPromoCode(ResponseHandler callback);

        /**
         * Async version of {@link Service#getRedundantPowerSupplyCount}
         */
        public Future getRedundantPowerSupplyCount();

        /**
         * Async callback version of {@link Service#getRedundantPowerSupplyCount}
         */
        public Future getRedundantPowerSupplyCount(ResponseHandler callback);

        /**
         * Async version of {@link Service#getSoftwareDescription}
         */
        public Future getSoftwareDescription();

        /**
         * Async callback version of {@link Service#getSoftwareDescription}
         */
        public Future getSoftwareDescription(ResponseHandler callback);

        /**
         * Async version of {@link Service#getStorageGroups}
         */
        public Future> getStorageGroups();

        /**
         * Async callback version of {@link Service#getStorageGroups}
         */
        public Future getStorageGroups(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getTotalRecurringAmount}
         */
        public Future getTotalRecurringAmount();

        /**
         * Async callback version of {@link Service#getTotalRecurringAmount}
         */
        public Future getTotalRecurringAmount(ResponseHandler callback);

        /**
         * Async version of {@link Service#getUpgradeItem}
         */
        public Future getUpgradeItem();

        /**
         * Async callback version of {@link Service#getUpgradeItem}
         */
        public Future getUpgradeItem(ResponseHandler callback);

    }

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

        public com.softlayer.api.service.billing.Item.Mask billingItem() {
            return withSubMask("billingItem", com.softlayer.api.service.billing.Item.Mask.class);
        }

        public Item.Mask bundledItems() {
            return withSubMask("bundledItems", Item.Mask.class);
        }

        public com.softlayer.api.service.product.item.Category.Mask category() {
            return withSubMask("category", com.softlayer.api.service.product.item.Category.Mask.class);
        }

        public Item.Mask children() {
            return withSubMask("children", Item.Mask.class);
        }

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

        public com.softlayer.api.service.hardware.component.model.Generic.Mask hardwareGenericComponent() {
            return withSubMask("hardwareGenericComponent", com.softlayer.api.service.hardware.component.model.Generic.Mask.class);
        }

        public com.softlayer.api.service.product.Item.Mask item() {
            return withSubMask("item", com.softlayer.api.service.product.Item.Mask.class);
        }

        public com.softlayer.api.service.billing.order.item.category.Answer.Mask itemCategoryAnswers() {
            return withSubMask("itemCategoryAnswers", com.softlayer.api.service.billing.order.item.category.Answer.Mask.class);
        }

        public com.softlayer.api.service.product.item.Price.Mask itemPrice() {
            return withSubMask("itemPrice", com.softlayer.api.service.product.item.Price.Mask.class);
        }

        public com.softlayer.api.service.Location.Mask location() {
            return withSubMask("location", com.softlayer.api.service.Location.Mask.class);
        }

        public Item.Mask nextOrderChildren() {
            return withSubMask("nextOrderChildren", Item.Mask.class);
        }

        public com.softlayer.api.service.billing.Item.Mask oldBillingItem() {
            return withSubMask("oldBillingItem", com.softlayer.api.service.billing.Item.Mask.class);
        }

        public com.softlayer.api.service.billing.Order.Mask order() {
            return withSubMask("order", com.softlayer.api.service.billing.Order.Mask.class);
        }

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

        public com.softlayer.api.service.product.Package.Mask itemPackage() {
            return withSubMask("package", com.softlayer.api.service.product.Package.Mask.class);
        }

        public Item.Mask parent() {
            return withSubMask("parent", Item.Mask.class);
        }

        public com.softlayer.api.service.product.pkg.Preset.Mask preset() {
            return withSubMask("preset", com.softlayer.api.service.product.pkg.Preset.Mask.class);
        }

        public com.softlayer.api.service.product.Promotion.Mask promoCode() {
            return withSubMask("promoCode", com.softlayer.api.service.product.Promotion.Mask.class);
        }

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

        public com.softlayer.api.service.software.Description.Mask softwareDescription() {
            return withSubMask("softwareDescription", com.softlayer.api.service.software.Description.Mask.class);
        }

        public com.softlayer.api.service.configuration.storage.group.Order.Mask storageGroups() {
            return withSubMask("storageGroups", com.softlayer.api.service.configuration.storage.group.Order.Mask.class);
        }

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

        public com.softlayer.api.service.product.Item.Mask upgradeItem() {
            return withSubMask("upgradeItem", com.softlayer.api.service.product.Item.Mask.class);
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy