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

com.softlayer.api.service.product.item.Price Maven / Gradle / Ivy

Go to download

API client for accessing the SoftLayer API

The newest version!
package com.softlayer.api.service.product.item;

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.location.group.Pricing;
import com.softlayer.api.service.product.Item;
import com.softlayer.api.service.product.Package;
import com.softlayer.api.service.product.item.Bundles;
import com.softlayer.api.service.product.item.Category;
import com.softlayer.api.service.product.item.category.order.option.Type;
import com.softlayer.api.service.product.item.price.Attribute;
import com.softlayer.api.service.product.item.price.Premium;
import com.softlayer.api.service.product.item.price.account.Restriction;
import com.softlayer.api.service.product.pkg.item.Prices;
import com.softlayer.api.service.product.pkg.preset.Configuration;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Product_Item_Price data type contains general information relating to a single SoftLayer product item price. You can find out what packages each price is in as well as which category under which this price is sold. All prices are returned in floating point values measured in US Dollars ($USD). 
 *
 * @see SoftLayer_Product_Item_Price
 */
@ApiType("SoftLayer_Product_Item_Price")
public class Price extends Entity {

    /**
     * The account that the item price is restricted to.
     */
    @ApiProperty
    protected List accountRestrictions;

    public List getAccountRestrictions() {
        if (accountRestrictions == null) {
            accountRestrictions = new ArrayList();
        }
        return accountRestrictions;
    }

    @ApiProperty
    protected List attributes;

    public List getAttributes() {
        if (attributes == null) {
            attributes = new ArrayList();
        }
        return attributes;
    }

    /**
     * Signifies pricing that is only available on a bare metal reserved capacity order.
     */
    @ApiProperty
    protected Boolean bareMetalReservedCapacityFlag;

    public Boolean getBareMetalReservedCapacityFlag() {
        return bareMetalReservedCapacityFlag;
    }

    public void setBareMetalReservedCapacityFlag(Boolean bareMetalReservedCapacityFlag) {
        this.bareMetalReservedCapacityFlag = bareMetalReservedCapacityFlag;
    }

    /**
     * Whether the price is for Big Data OS/Journal disks only. (Deprecated)
     */
    @ApiProperty
    protected Boolean bigDataOsJournalDiskFlag;

    public Boolean getBigDataOsJournalDiskFlag() {
        return bigDataOsJournalDiskFlag;
    }

    public void setBigDataOsJournalDiskFlag(Boolean bigDataOsJournalDiskFlag) {
        this.bigDataOsJournalDiskFlag = bigDataOsJournalDiskFlag;
    }

    /**
     * cross reference for bundles
     */
    @ApiProperty
    protected List bundleReferences;

    public List getBundleReferences() {
        if (bundleReferences == null) {
            bundleReferences = new ArrayList();
        }
        return bundleReferences;
    }

    /**
     * The maximum capacity value for which this price is suitable.
     */
    @ApiProperty
    protected String capacityRestrictionMaximum;

    public String getCapacityRestrictionMaximum() {
        return capacityRestrictionMaximum;
    }

    public void setCapacityRestrictionMaximum(String capacityRestrictionMaximum) {
        this.capacityRestrictionMaximum = capacityRestrictionMaximum;
    }

    /**
     * The minimum capacity value for which this price is suitable.
     */
    @ApiProperty
    protected String capacityRestrictionMinimum;

    public String getCapacityRestrictionMinimum() {
        return capacityRestrictionMinimum;
    }

    public void setCapacityRestrictionMinimum(String capacityRestrictionMinimum) {
        this.capacityRestrictionMinimum = capacityRestrictionMinimum;
    }

    /**
     * The type of capacity restriction by which this price must abide.
     */
    @ApiProperty
    protected String capacityRestrictionType;

    public String getCapacityRestrictionType() {
        return capacityRestrictionType;
    }

    public void setCapacityRestrictionType(String capacityRestrictionType) {
        this.capacityRestrictionType = capacityRestrictionType;
    }

    /**
     * All categories which this item is a member.
     */
    @ApiProperty
    protected List categories;

    public List getCategories() {
        if (categories == null) {
            categories = new ArrayList();
        }
        return categories;
    }

    /**
     * Signifies pricing that is only available on a dedicated host virtual server order.
     */
    @ApiProperty
    protected Boolean dedicatedHostInstanceFlag;

    public Boolean getDedicatedHostInstanceFlag() {
        return dedicatedHostInstanceFlag;
    }

    public void setDedicatedHostInstanceFlag(Boolean dedicatedHostInstanceFlag) {
        this.dedicatedHostInstanceFlag = dedicatedHostInstanceFlag;
    }

    /**
     * Whether this price defines a software license for its product item.
     */
    @ApiProperty
    protected Boolean definedSoftwareLicenseFlag;

    public Boolean getDefinedSoftwareLicenseFlag() {
        return definedSoftwareLicenseFlag;
    }

    public void setDefinedSoftwareLicenseFlag(Boolean definedSoftwareLicenseFlag) {
        this.definedSoftwareLicenseFlag = definedSoftwareLicenseFlag;
    }

    /**
     * Eligibility strategy to assess if a customer can order using this price.
     */
    @ApiProperty
    protected String eligibilityStrategy;

    public String getEligibilityStrategy() {
        return eligibilityStrategy;
    }

    public void setEligibilityStrategy(String eligibilityStrategy) {
        this.eligibilityStrategy = eligibilityStrategy;
    }

    /**
     * The product item a price is tied to.
     */
    @ApiProperty
    protected Item item;

    public Item getItem() {
        return item;
    }

    public void setItem(Item item) {
        this.item = item;
    }

    @ApiProperty
    protected List orderPremiums;

    public List getOrderPremiums() {
        if (orderPremiums == null) {
            orderPremiums = new ArrayList();
        }
        return orderPremiums;
    }

    /**
     * cross reference for packages
     */
    @ApiProperty
    protected List packageReferences;

    public List getPackageReferences() {
        if (packageReferences == null) {
            packageReferences = new ArrayList();
        }
        return packageReferences;
    }

    /**
     * A price's packages under which this item is sold.
     */
    @ApiProperty
    protected List packages;

    public List getPackages() {
        if (packages == null) {
            packages = new ArrayList();
        }
        return packages;
    }

    /**
     * A list of preset configurations this price is used in.'
     */
    @ApiProperty
    protected List presetConfigurations;

    public List getPresetConfigurations() {
        if (presetConfigurations == null) {
            presetConfigurations = new ArrayList();
        }
        return presetConfigurations;
    }

    /**
     * The type keyname of this price which can be STANDARD, TIERED, or TERM.
     */
    @ApiProperty
    protected String priceType;

    public String getPriceType() {
        return priceType;
    }

    public void setPriceType(String priceType) {
        this.priceType = priceType;
    }

    /**
     * The pricing location group that this price is applicable for. Prices that have a pricing location group will only be available for ordering with the locations specified on the location group.
     */
    @ApiProperty
    protected Pricing pricingLocationGroup;

    public Pricing getPricingLocationGroup() {
        return pricingLocationGroup;
    }

    public void setPricingLocationGroup(Pricing pricingLocationGroup) {
        this.pricingLocationGroup = pricingLocationGroup;
    }

    /**
     * The number of server cores required to order this item. This is deprecated. Use [[SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum|getCapacityRestrictionMinimum]] and [[SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum|getCapacityRestrictionMaximum]]
     */
    @ApiProperty
    protected Long requiredCoreCount;

    public Long getRequiredCoreCount() {
        return requiredCoreCount;
    }

    public void setRequiredCoreCount(Long requiredCoreCount) {
        this.requiredCoreCount = requiredCoreCount;
    }

    /**
     * Signifies pricing that is only available on a reserved capacity virtual server order.
     */
    @ApiProperty
    protected Boolean reservedCapacityInstanceFlag;

    public Boolean getReservedCapacityInstanceFlag() {
        return reservedCapacityInstanceFlag;
    }

    public void setReservedCapacityInstanceFlag(Boolean reservedCapacityInstanceFlag) {
        this.reservedCapacityInstanceFlag = reservedCapacityInstanceFlag;
    }

    /**
     * This flag is used by the getUpgradeItemPrices methods available on various resources to indicate if a product price is used for the current billing item. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean currentPriceFlag;

    public Boolean getCurrentPriceFlag() {
        return currentPriceFlag;
    }

    public void setCurrentPriceFlag(Boolean currentPriceFlag) {
        currentPriceFlagSpecified = true;
        this.currentPriceFlag = currentPriceFlag;
    }

    protected boolean currentPriceFlagSpecified;

    public boolean isCurrentPriceFlagSpecified() {
        return currentPriceFlagSpecified;
    }

    public void unsetCurrentPriceFlag() {
        currentPriceFlag = null;
        currentPriceFlagSpecified = false;
    }

    /**
     * The hourly price for this item, should this item be part of an hourly pricing package. 
     */
    @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;
    }

    /**
     * The unique identifier of a Product Item Price.
     */
    @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 unique identifier for a product 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 labor fee for a product item price.
     */
    @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 id of the [[SoftLayer_Location_Group_Pricing]] that this price is part of. If set to null, the price is considered a standard price, which can be used with any location when ordering. 

     * 

     * During order [[SoftLayer_Product_Order/verifyOrder|verification]] and [[SoftLayer_Product_Order/placeOrder|placement]], if a standard price is used, that price may be replaced with a location based price, which does not have this property set to null. The location based price must be part of a [[SoftLayer_Location_Group_Pricing]] that has the location being ordered in order for this to happen. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long locationGroupId;

    public Long getLocationGroupId() {
        return locationGroupId;
    }

    public void setLocationGroupId(Long locationGroupId) {
        locationGroupIdSpecified = true;
        this.locationGroupId = locationGroupId;
    }

    protected boolean locationGroupIdSpecified;

    public boolean isLocationGroupIdSpecified() {
        return locationGroupIdSpecified;
    }

    public void unsetLocationGroupId() {
        locationGroupId = null;
        locationGroupIdSpecified = false;
    }

    /**
     * On sale flag.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean onSaleFlag;

    public Boolean getOnSaleFlag() {
        return onSaleFlag;
    }

    public void setOnSaleFlag(Boolean onSaleFlag) {
        onSaleFlagSpecified = true;
        this.onSaleFlag = onSaleFlag;
    }

    protected boolean onSaleFlagSpecified;

    public boolean isOnSaleFlagSpecified() {
        return onSaleFlagSpecified;
    }

    public void unsetOnSaleFlag() {
        onSaleFlag = null;
        onSaleFlagSpecified = false;
    }

    /**
     * The one time fee for a product item price.
     */
    @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;
    }

    /**
     * A price's total tax amount of the one time fees (oneTimeFee, laborFee, and setupFee). This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder()
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal oneTimeFeeTax;

    public BigDecimal getOneTimeFeeTax() {
        return oneTimeFeeTax;
    }

    public void setOneTimeFeeTax(BigDecimal oneTimeFeeTax) {
        oneTimeFeeTaxSpecified = true;
        this.oneTimeFeeTax = oneTimeFeeTax;
    }

    protected boolean oneTimeFeeTaxSpecified;

    public boolean isOneTimeFeeTaxSpecified() {
        return oneTimeFeeTaxSpecified;
    }

    public void unsetOneTimeFeeTax() {
        oneTimeFeeTax = null;
        oneTimeFeeTaxSpecified = false;
    }

    /**
     * Order options for the category that this price is associated with. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected List orderOptions;

    public List getOrderOptions() {
        if (orderOptions == null) {
            orderOptions = new ArrayList();
        }
        return orderOptions;
    }

    protected boolean orderOptionsSpecified;

    public boolean isOrderOptionsSpecified() {
        return orderOptionsSpecified;
    }

    public void unsetOrderOptions() {
        orderOptions = null;
        orderOptionsSpecified = false;
    }

    /**
     * A recurring fee is a fee that happens every billing period. This fee is represented as a floating point decimal in US dollars ($USD).
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal proratedRecurringFee;

    public BigDecimal getProratedRecurringFee() {
        return proratedRecurringFee;
    }

    public void setProratedRecurringFee(BigDecimal proratedRecurringFee) {
        proratedRecurringFeeSpecified = true;
        this.proratedRecurringFee = proratedRecurringFee;
    }

    protected boolean proratedRecurringFeeSpecified;

    public boolean isProratedRecurringFeeSpecified() {
        return proratedRecurringFeeSpecified;
    }

    public void unsetProratedRecurringFee() {
        proratedRecurringFee = null;
        proratedRecurringFeeSpecified = false;
    }

    /**
     * A price's tax amount of the recurring fee. This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder()
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal proratedRecurringFeeTax;

    public BigDecimal getProratedRecurringFeeTax() {
        return proratedRecurringFeeTax;
    }

    public void setProratedRecurringFeeTax(BigDecimal proratedRecurringFeeTax) {
        proratedRecurringFeeTaxSpecified = true;
        this.proratedRecurringFeeTax = proratedRecurringFeeTax;
    }

    protected boolean proratedRecurringFeeTaxSpecified;

    public boolean isProratedRecurringFeeTaxSpecified() {
        return proratedRecurringFeeTaxSpecified;
    }

    public void unsetProratedRecurringFeeTax() {
        proratedRecurringFeeTax = null;
        proratedRecurringFeeTaxSpecified = false;
    }

    @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;
    }

    /**
     * A recurring fee is a fee that happens every billing period. This fee is represented as a floating point decimal 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;
    }

    /**
     * A price's tax amount of the recurring fee. This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder()
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal recurringFeeTax;

    public BigDecimal getRecurringFeeTax() {
        return recurringFeeTax;
    }

    public void setRecurringFeeTax(BigDecimal recurringFeeTax) {
        recurringFeeTaxSpecified = true;
        this.recurringFeeTax = recurringFeeTax;
    }

    protected boolean recurringFeeTaxSpecified;

    public boolean isRecurringFeeTaxSpecified() {
        return recurringFeeTaxSpecified;
    }

    public void unsetRecurringFeeTax() {
        recurringFeeTax = null;
        recurringFeeTaxSpecified = false;
    }

    /**
     * The setup fee associated with a product item price.
     */
    @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;
    }

    /**
     * Used for ordering items on sales orders.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long sort;

    public Long getSort() {
        return sort;
    }

    public void setSort(Long sort) {
        sortSpecified = true;
        this.sort = sort;
    }

    protected boolean sortSpecified;

    public boolean isSortSpecified() {
        return sortSpecified;
    }

    public void unsetSort() {
        sort = null;
        sortSpecified = false;
    }

    /**
     * The number of months a term lasts for a term-based price
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long termLength;

    public Long getTermLength() {
        return termLength;
    }

    public void setTermLength(Long termLength) {
        termLengthSpecified = true;
        this.termLength = termLength;
    }

    protected boolean termLengthSpecified;

    public boolean isTermLengthSpecified() {
        return termLengthSpecified;
    }

    public void unsetTermLength() {
        termLength = null;
        termLengthSpecified = false;
    }

    /**
     * The minimum threshold for which this tiered usage price begins to apply.  The unit for the price is defined by the item to which this belongs, see [[SoftLayer_Product_Item::$units]]. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long tierMinimumThreshold;

    public Long getTierMinimumThreshold() {
        return tierMinimumThreshold;
    }

    public void setTierMinimumThreshold(Long tierMinimumThreshold) {
        tierMinimumThresholdSpecified = true;
        this.tierMinimumThreshold = tierMinimumThreshold;
    }

    protected boolean tierMinimumThresholdSpecified;

    public boolean isTierMinimumThresholdSpecified() {
        return tierMinimumThresholdSpecified;
    }

    public void unsetTierMinimumThreshold() {
        tierMinimumThreshold = null;
        tierMinimumThresholdSpecified = false;
    }

    /**
     * The rate for a usage based item
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal usageRate;

    public BigDecimal getUsageRate() {
        return usageRate;
    }

    public void setUsageRate(BigDecimal usageRate) {
        usageRateSpecified = true;
        this.usageRate = usageRate;
    }

    protected boolean usageRateSpecified;

    public boolean isUsageRateSpecified() {
        return usageRateSpecified;
    }

    public void unsetUsageRate() {
        usageRate = null;
        usageRateSpecified = false;
    }

    /**
     * A count of the account that the item price is restricted to.
     */
    @ApiProperty
    protected Long accountRestrictionCount;

    public Long getAccountRestrictionCount() {
        return accountRestrictionCount;
    }

    public void setAccountRestrictionCount(Long accountRestrictionCount) {
        this.accountRestrictionCount = accountRestrictionCount;
    }

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

    public Long getAttributeCount() {
        return attributeCount;
    }

    public void setAttributeCount(Long attributeCount) {
        this.attributeCount = attributeCount;
    }

    /**
     * A count of cross reference for bundles
     */
    @ApiProperty
    protected Long bundleReferenceCount;

    public Long getBundleReferenceCount() {
        return bundleReferenceCount;
    }

    public void setBundleReferenceCount(Long bundleReferenceCount) {
        this.bundleReferenceCount = bundleReferenceCount;
    }

    /**
     * A count of all categories which this item is a member.
     */
    @ApiProperty
    protected Long categoryCount;

    public Long getCategoryCount() {
        return categoryCount;
    }

    public void setCategoryCount(Long categoryCount) {
        this.categoryCount = categoryCount;
    }

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

    public Long getOrderPremiumCount() {
        return orderPremiumCount;
    }

    public void setOrderPremiumCount(Long orderPremiumCount) {
        this.orderPremiumCount = orderPremiumCount;
    }

    /**
     * A count of a price's packages under which this item is sold.
     */
    @ApiProperty
    protected Long packageCount;

    public Long getPackageCount() {
        return packageCount;
    }

    public void setPackageCount(Long packageCount) {
        this.packageCount = packageCount;
    }

    /**
     * A count of cross reference for packages
     */
    @ApiProperty
    protected Long packageReferenceCount;

    public Long getPackageReferenceCount() {
        return packageReferenceCount;
    }

    public void setPackageReferenceCount(Long packageReferenceCount) {
        this.packageReferenceCount = packageReferenceCount;
    }

    /**
     * A count of a list of preset configurations this price is used in.'
     */
    @ApiProperty
    protected Long presetConfigurationCount;

    public Long getPresetConfigurationCount() {
        return presetConfigurationCount;
    }

    public void setPresetConfigurationCount(Long presetConfigurationCount) {
        this.presetConfigurationCount = presetConfigurationCount;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    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());
    }

    /**
     * The SoftLayer_Product_Item_Price contains general information relating to a single SoftLayer product item price. You can find out what packages each price is in as well as which category under which this price is sold. All prices are returned in floating point values measured in US Dollars ($USD). 
     *
     * @see SoftLayer_Product_Item_Price
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Product_Item_Price")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * @see SoftLayer_Product_Item_Price::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Price getObject();

        /**
         * Returns a collection of rate-based [[SoftLayer_Product_Item_Price]] objects associated with the [[SoftLayer_Product_Item]] objects and the [[SoftLayer_Location]] specified. The location is required to get the appropriate rate-based prices because the usage rates may vary from datacenter to datacenter. 
         *
         * @see SoftLayer_Product_Item_Price::getUsageRatePrices
         */
        @ApiMethod
        public List getUsageRatePrices(Location location, List items);

        /**
         * The account that the item price is restricted to.
         *
         * @see SoftLayer_Product_Item_Price::getAccountRestrictions
         */
        @ApiMethod(instanceRequired = true)
        public List getAccountRestrictions();

        /**
         * @see SoftLayer_Product_Item_Price::getAttributes
         */
        @ApiMethod(instanceRequired = true)
        public List getAttributes();

        /**
         * Signifies pricing that is only available on a bare metal reserved capacity order.
         *
         * @see SoftLayer_Product_Item_Price::getBareMetalReservedCapacityFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getBareMetalReservedCapacityFlag();

        /**
         * Whether the price is for Big Data OS/Journal disks only. (Deprecated)
         *
         * @see SoftLayer_Product_Item_Price::getBigDataOsJournalDiskFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getBigDataOsJournalDiskFlag();

        /**
         * cross reference for bundles
         *
         * @see SoftLayer_Product_Item_Price::getBundleReferences
         */
        @ApiMethod(instanceRequired = true)
        public List getBundleReferences();

        /**
         * The maximum capacity value for which this price is suitable.
         *
         * @see SoftLayer_Product_Item_Price::getCapacityRestrictionMaximum
         */
        @ApiMethod(instanceRequired = true)
        public String getCapacityRestrictionMaximum();

        /**
         * The minimum capacity value for which this price is suitable.
         *
         * @see SoftLayer_Product_Item_Price::getCapacityRestrictionMinimum
         */
        @ApiMethod(instanceRequired = true)
        public String getCapacityRestrictionMinimum();

        /**
         * The type of capacity restriction by which this price must abide.
         *
         * @see SoftLayer_Product_Item_Price::getCapacityRestrictionType
         */
        @ApiMethod(instanceRequired = true)
        public String getCapacityRestrictionType();

        /**
         * All categories which this item is a member.
         *
         * @see SoftLayer_Product_Item_Price::getCategories
         */
        @ApiMethod(instanceRequired = true)
        public List getCategories();

        /**
         * Signifies pricing that is only available on a dedicated host virtual server order.
         *
         * @see SoftLayer_Product_Item_Price::getDedicatedHostInstanceFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getDedicatedHostInstanceFlag();

        /**
         * Whether this price defines a software license for its product item.
         *
         * @see SoftLayer_Product_Item_Price::getDefinedSoftwareLicenseFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getDefinedSoftwareLicenseFlag();

        /**
         * Eligibility strategy to assess if a customer can order using this price.
         *
         * @see SoftLayer_Product_Item_Price::getEligibilityStrategy
         */
        @ApiMethod(instanceRequired = true)
        public String getEligibilityStrategy();

        /**
         * The product item a price is tied to.
         *
         * @see SoftLayer_Product_Item_Price::getItem
         */
        @ApiMethod(instanceRequired = true)
        public Item getItem();

        /**
         * @see SoftLayer_Product_Item_Price::getOrderPremiums
         */
        @ApiMethod(instanceRequired = true)
        public List getOrderPremiums();

        /**
         * cross reference for packages
         *
         * @see SoftLayer_Product_Item_Price::getPackageReferences
         */
        @ApiMethod(instanceRequired = true)
        public List getPackageReferences();

        /**
         * A price's packages under which this item is sold.
         *
         * @see SoftLayer_Product_Item_Price::getPackages
         */
        @ApiMethod(instanceRequired = true)
        public List getPackages();

        /**
         * A list of preset configurations this price is used in.'
         *
         * @see SoftLayer_Product_Item_Price::getPresetConfigurations
         */
        @ApiMethod(instanceRequired = true)
        public List getPresetConfigurations();

        /**
         * The type keyname of this price which can be STANDARD, TIERED, or TERM.
         *
         * @see SoftLayer_Product_Item_Price::getPriceType
         */
        @ApiMethod(instanceRequired = true)
        public String getPriceType();

        /**
         * The pricing location group that this price is applicable for. Prices that have a pricing location group will only be available for ordering with the locations specified on the location group.
         *
         * @see SoftLayer_Product_Item_Price::getPricingLocationGroup
         */
        @ApiMethod(instanceRequired = true)
        public Pricing getPricingLocationGroup();

        /**
         * The number of server cores required to order this item. This is deprecated. Use [[SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum|getCapacityRestrictionMinimum]] and [[SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum|getCapacityRestrictionMaximum]]
         *
         * @see SoftLayer_Product_Item_Price::getRequiredCoreCount
         */
        @ApiMethod(instanceRequired = true)
        public Long getRequiredCoreCount();

        /**
         * Signifies pricing that is only available on a reserved capacity virtual server order.
         *
         * @see SoftLayer_Product_Item_Price::getReservedCapacityInstanceFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getReservedCapacityInstanceFlag();

    }

    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#getUsageRatePrices}
         */
        public Future> getUsageRatePrices(Location location, List items);

        public Future getUsageRatePrices(Location location, List items, ResponseHandler> callback);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        /**
         * Async callback version of {@link Service#getEligibilityStrategy}
         */
        public Future getEligibilityStrategy(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#getOrderPremiums}
         */
        public Future> getOrderPremiums();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

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

        public com.softlayer.api.service.product.item.price.account.Restriction.Mask accountRestrictions() {
            return withSubMask("accountRestrictions", com.softlayer.api.service.product.item.price.account.Restriction.Mask.class);
        }

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

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

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

        public Bundles.Mask bundleReferences() {
            return withSubMask("bundleReferences", Bundles.Mask.class);
        }

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

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

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

        public Category.Mask categories() {
            return withSubMask("categories", Category.Mask.class);
        }

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

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

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

        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.product.item.price.Premium.Mask orderPremiums() {
            return withSubMask("orderPremiums", com.softlayer.api.service.product.item.price.Premium.Mask.class);
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy