com.softlayer.api.service.billing.Order Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service.billing;
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.Account;
import com.softlayer.api.service.Brand;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.billing.Invoice;
import com.softlayer.api.service.billing.currency.ExchangeRate;
import com.softlayer.api.service.billing.order.Cart;
import com.softlayer.api.service.billing.order.Item;
import com.softlayer.api.service.billing.order.Quote;
import com.softlayer.api.service.billing.order.Type;
import com.softlayer.api.service.billing.payment.paypal.Transaction;
import com.softlayer.api.service.container.billing.order.Status;
import com.softlayer.api.service.container.product.order.Receipt;
import com.softlayer.api.service.sales.presale.Event;
import com.softlayer.api.service.user.Customer;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;
/**
* The SoftLayer_Billing_Order data type contains general information relating to an individual order applied to a SoftLayer customer account or to a new customer. Personal information in this type such as names, addresses, and phone numbers are taken from the account's contact information at the time the order is generated for existing SoftLayer customer.
*
* @see SoftLayer_Billing_Order
*/
@ApiType("SoftLayer_Billing_Order")
public class Order extends Entity {
/**
* The [[SoftLayer_Account|account]] to which an order belongs.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
@ApiProperty
protected Brand brand;
public Brand getBrand() {
return brand;
}
public void setBrand(Brand brand) {
this.brand = brand;
}
/**
* A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See [[SoftLayer_Billing_Order_Cart]] for more information.
*/
@ApiProperty
protected Cart cart;
public Cart getCart() {
return cart;
}
public void setCart(Cart cart) {
this.cart = cart;
}
/**
* The [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restricted
*/
@ApiProperty
protected List- coreRestrictedItems;
public List
- getCoreRestrictedItems() {
if (coreRestrictedItems == null) {
coreRestrictedItems = new ArrayList
- ();
}
return coreRestrictedItems;
}
/**
* All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.
*/
@ApiProperty
protected List
creditCardTransactions;
public List getCreditCardTransactions() {
if (creditCardTransactions == null) {
creditCardTransactions = new ArrayList();
}
return creditCardTransactions;
}
@ApiProperty
protected ExchangeRate exchangeRate;
public ExchangeRate getExchangeRate() {
return exchangeRate;
}
public void setExchangeRate(ExchangeRate exchangeRate) {
this.exchangeRate = exchangeRate;
}
@ApiProperty
protected Invoice initialInvoice;
public Invoice getInitialInvoice() {
return initialInvoice;
}
public void setInitialInvoice(Invoice initialInvoice) {
this.initialInvoice = initialInvoice;
}
/**
* The SoftLayer_Billing_Order_items included in an order.
*/
@ApiProperty
protected List- items;
public List
- getItems() {
if (items == null) {
items = new ArrayList
- ();
}
return items;
}
@ApiProperty
protected GregorianCalendar orderApprovalDate;
public GregorianCalendar getOrderApprovalDate() {
return orderApprovalDate;
}
public void setOrderApprovalDate(GregorianCalendar orderApprovalDate) {
this.orderApprovalDate = orderApprovalDate;
}
/**
* An order's non-server items total monthly fee.
*/
@ApiProperty
protected BigDecimal orderNonServerMonthlyAmount;
public BigDecimal getOrderNonServerMonthlyAmount() {
return orderNonServerMonthlyAmount;
}
public void setOrderNonServerMonthlyAmount(BigDecimal orderNonServerMonthlyAmount) {
this.orderNonServerMonthlyAmount = orderNonServerMonthlyAmount;
}
/**
* An order's server items total monthly fee.
*/
@ApiProperty
protected BigDecimal orderServerMonthlyAmount;
public BigDecimal getOrderServerMonthlyAmount() {
return orderServerMonthlyAmount;
}
public void setOrderServerMonthlyAmount(BigDecimal orderServerMonthlyAmount) {
this.orderServerMonthlyAmount = orderServerMonthlyAmount;
}
/**
* An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.
*/
@ApiProperty
protected List
- orderTopLevelItems;
public List
- getOrderTopLevelItems() {
if (orderTopLevelItems == null) {
orderTopLevelItems = new ArrayList
- ();
}
return orderTopLevelItems;
}
/**
* This amount represents the order's initial charge including set up fee and taxes.
*/
@ApiProperty
protected BigDecimal orderTotalAmount;
public BigDecimal getOrderTotalAmount() {
return orderTotalAmount;
}
public void setOrderTotalAmount(BigDecimal orderTotalAmount) {
this.orderTotalAmount = orderTotalAmount;
}
/**
* An order's total one time amount summing all the set up fees, the labor fees and the one time fees. Taxes will be applied for non-tax-exempt. This amount represents the initial fees that will be charged.
*/
@ApiProperty
protected BigDecimal orderTotalOneTime;
public BigDecimal getOrderTotalOneTime() {
return orderTotalOneTime;
}
public void setOrderTotalOneTime(BigDecimal orderTotalOneTime) {
this.orderTotalOneTime = orderTotalOneTime;
}
/**
* An order's total one time amount. This amount represents the initial fees before tax.
*/
@ApiProperty
protected BigDecimal orderTotalOneTimeAmount;
public BigDecimal getOrderTotalOneTimeAmount() {
return orderTotalOneTimeAmount;
}
public void setOrderTotalOneTimeAmount(BigDecimal orderTotalOneTimeAmount) {
this.orderTotalOneTimeAmount = orderTotalOneTimeAmount;
}
/**
* An order's total one time tax amount. This amount represents the tax that will be applied to the total charge, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.
*/
@ApiProperty
protected BigDecimal orderTotalOneTimeTaxAmount;
public BigDecimal getOrderTotalOneTimeTaxAmount() {
return orderTotalOneTimeTaxAmount;
}
public void setOrderTotalOneTimeTaxAmount(BigDecimal orderTotalOneTimeTaxAmount) {
this.orderTotalOneTimeTaxAmount = orderTotalOneTimeTaxAmount;
}
/**
* An order's total recurring amount. Taxes will be applied for non-tax-exempt. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
*/
@ApiProperty
protected BigDecimal orderTotalRecurring;
public BigDecimal getOrderTotalRecurring() {
return orderTotalRecurring;
}
public void setOrderTotalRecurring(BigDecimal orderTotalRecurring) {
this.orderTotalRecurring = orderTotalRecurring;
}
/**
* An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
*/
@ApiProperty
protected BigDecimal orderTotalRecurringAmount;
public BigDecimal getOrderTotalRecurringAmount() {
return orderTotalRecurringAmount;
}
public void setOrderTotalRecurringAmount(BigDecimal orderTotalRecurringAmount) {
this.orderTotalRecurringAmount = orderTotalRecurringAmount;
}
/**
* The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.
*/
@ApiProperty
protected BigDecimal orderTotalRecurringTaxAmount;
public BigDecimal getOrderTotalRecurringTaxAmount() {
return orderTotalRecurringTaxAmount;
}
public void setOrderTotalRecurringTaxAmount(BigDecimal orderTotalRecurringTaxAmount) {
this.orderTotalRecurringTaxAmount = orderTotalRecurringTaxAmount;
}
/**
* An order's total setup fee.
*/
@ApiProperty
protected BigDecimal orderTotalSetupAmount;
public BigDecimal getOrderTotalSetupAmount() {
return orderTotalSetupAmount;
}
public void setOrderTotalSetupAmount(BigDecimal orderTotalSetupAmount) {
this.orderTotalSetupAmount = orderTotalSetupAmount;
}
/**
* The type of an order. This lets you know where this order was generated from.
*/
@ApiProperty
protected Type orderType;
public Type getOrderType() {
return orderType;
}
public void setOrderType(Type orderType) {
this.orderType = orderType;
}
/**
* All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.
*/
@ApiProperty
protected List
paypalTransactions;
public List getPaypalTransactions() {
if (paypalTransactions == null) {
paypalTransactions = new ArrayList();
}
return paypalTransactions;
}
@ApiProperty
protected Event presaleEvent;
public Event getPresaleEvent() {
return presaleEvent;
}
public void setPresaleEvent(Event presaleEvent) {
this.presaleEvent = presaleEvent;
}
/**
* The quote of an order. This quote holds information about its expiration date, creation date, name and status. This information is tied to an order having the status 'QUOTE'
*/
@ApiProperty
protected Quote quote;
public Quote getQuote() {
return quote;
}
public void setQuote(Quote quote) {
this.quote = quote;
}
/**
* The Referral Partner who referred this order. (Only necessary for new customer orders)
*/
@ApiProperty
protected Account referralPartner;
public Account getReferralPartner() {
return referralPartner;
}
public void setReferralPartner(Account referralPartner) {
this.referralPartner = referralPartner;
}
/**
* This flag indicates an order is an upgrade.
*/
@ApiProperty
protected Boolean upgradeRequestFlag;
public Boolean getUpgradeRequestFlag() {
return upgradeRequestFlag;
}
public void setUpgradeRequestFlag(Boolean upgradeRequestFlag) {
this.upgradeRequestFlag = upgradeRequestFlag;
}
/**
* The SoftLayer_User_Customer object tied to an order.
*/
@ApiProperty
protected Customer userRecord;
public Customer getUserRecord() {
return userRecord;
}
public void setUserRecord(Customer userRecord) {
this.userRecord = userRecord;
}
/**
* The account ID to which an order belongs.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long accountId;
public Long getAccountId() {
return accountId;
}
public void setAccountId(Long accountId) {
accountIdSpecified = true;
this.accountId = accountId;
}
protected boolean accountIdSpecified;
public boolean isAccountIdSpecified() {
return accountIdSpecified;
}
public void unsetAccountId() {
accountId = null;
accountIdSpecified = false;
}
/**
* The point in time at which a billing item was created.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar createDate;
public GregorianCalendar getCreateDate() {
return createDate;
}
public void setCreateDate(GregorianCalendar createDate) {
createDateSpecified = true;
this.createDate = createDate;
}
protected boolean createDateSpecified;
public boolean isCreateDateSpecified() {
return createDateSpecified;
}
public void unsetCreateDate() {
createDate = null;
createDateSpecified = 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_User_Customer id of the portal or API user who impersonated the user which submitted an order.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long impersonatingUserRecordId;
public Long getImpersonatingUserRecordId() {
return impersonatingUserRecordId;
}
public void setImpersonatingUserRecordId(Long impersonatingUserRecordId) {
impersonatingUserRecordIdSpecified = true;
this.impersonatingUserRecordId = impersonatingUserRecordId;
}
protected boolean impersonatingUserRecordIdSpecified;
public boolean isImpersonatingUserRecordIdSpecified() {
return impersonatingUserRecordIdSpecified;
}
public void unsetImpersonatingUserRecordId() {
impersonatingUserRecordId = null;
impersonatingUserRecordIdSpecified = false;
}
/**
* The last time an order was updated.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar modifyDate;
public GregorianCalendar getModifyDate() {
return modifyDate;
}
public void setModifyDate(GregorianCalendar modifyDate) {
modifyDateSpecified = true;
this.modifyDate = modifyDate;
}
protected boolean modifyDateSpecified;
public boolean isModifyDateSpecified() {
return modifyDateSpecified;
}
public void unsetModifyDate() {
modifyDate = null;
modifyDateSpecified = false;
}
/**
* The SoftLayer_Billing_Order_Quote id of the quote's user who finalized an order.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long orderQuoteId;
public Long getOrderQuoteId() {
return orderQuoteId;
}
public void setOrderQuoteId(Long orderQuoteId) {
orderQuoteIdSpecified = true;
this.orderQuoteId = orderQuoteId;
}
protected boolean orderQuoteIdSpecified;
public boolean isOrderQuoteIdSpecified() {
return orderQuoteIdSpecified;
}
public void unsetOrderQuoteId() {
orderQuoteId = null;
orderQuoteIdSpecified = false;
}
/**
* The SoftLayer_Billing_Order_Type id of the order.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long orderTypeId;
public Long getOrderTypeId() {
return orderTypeId;
}
public void setOrderTypeId(Long orderTypeId) {
orderTypeIdSpecified = true;
this.orderTypeId = orderTypeId;
}
protected boolean orderTypeIdSpecified;
public boolean isOrderTypeIdSpecified() {
return orderTypeIdSpecified;
}
public void unsetOrderTypeId() {
orderTypeId = null;
orderTypeIdSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected Long presaleEventId;
public Long getPresaleEventId() {
return presaleEventId;
}
public void setPresaleEventId(Long presaleEventId) {
presaleEventIdSpecified = true;
this.presaleEventId = presaleEventId;
}
protected boolean presaleEventIdSpecified;
public boolean isPresaleEventIdSpecified() {
return presaleEventIdSpecified;
}
public void unsetPresaleEventId() {
presaleEventId = null;
presaleEventIdSpecified = false;
}
/**
* Flag indicating a private cloud solution order (Deprecated)
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean privateCloudOrderFlag;
public Boolean getPrivateCloudOrderFlag() {
return privateCloudOrderFlag;
}
public void setPrivateCloudOrderFlag(Boolean privateCloudOrderFlag) {
privateCloudOrderFlagSpecified = true;
this.privateCloudOrderFlag = privateCloudOrderFlag;
}
protected boolean privateCloudOrderFlagSpecified;
public boolean isPrivateCloudOrderFlagSpecified() {
return privateCloudOrderFlagSpecified;
}
public void unsetPrivateCloudOrderFlag() {
privateCloudOrderFlag = null;
privateCloudOrderFlagSpecified = false;
}
/**
* Purchaser current status e.i. Approved, Pending_Approval
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String status;
public String getStatus() {
return status;
}
public void setStatus(String status) {
statusSpecified = true;
this.status = status;
}
protected boolean statusSpecified;
public boolean isStatusSpecified() {
return statusSpecified;
}
public void unsetStatus() {
status = null;
statusSpecified = false;
}
/**
* The SoftLayer_User_Customer id of the portal or API user who submitted an order.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long userRecordId;
public Long getUserRecordId() {
return userRecordId;
}
public void setUserRecordId(Long userRecordId) {
userRecordIdSpecified = true;
this.userRecordId = userRecordId;
}
protected boolean userRecordIdSpecified;
public boolean isUserRecordIdSpecified() {
return userRecordIdSpecified;
}
public void unsetUserRecordId() {
userRecordId = null;
userRecordIdSpecified = false;
}
/**
* A count of the [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restricted
*/
@ApiProperty
protected Long coreRestrictedItemCount;
public Long getCoreRestrictedItemCount() {
return coreRestrictedItemCount;
}
public void setCoreRestrictedItemCount(Long coreRestrictedItemCount) {
this.coreRestrictedItemCount = coreRestrictedItemCount;
}
/**
* A count of all credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.
*/
@ApiProperty
protected Long creditCardTransactionCount;
public Long getCreditCardTransactionCount() {
return creditCardTransactionCount;
}
public void setCreditCardTransactionCount(Long creditCardTransactionCount) {
this.creditCardTransactionCount = creditCardTransactionCount;
}
/**
* A count of the SoftLayer_Billing_Order_items included in an order.
*/
@ApiProperty
protected Long itemCount;
public Long getItemCount() {
return itemCount;
}
public void setItemCount(Long itemCount) {
this.itemCount = itemCount;
}
/**
* A count of an order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.
*/
@ApiProperty
protected Long orderTopLevelItemCount;
public Long getOrderTopLevelItemCount() {
return orderTopLevelItemCount;
}
public void setOrderTopLevelItemCount(Long orderTopLevelItemCount) {
this.orderTopLevelItemCount = orderTopLevelItemCount;
}
/**
* A count of all PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.
*/
@ApiProperty
protected Long paypalTransactionCount;
public Long getPaypalTransactionCount() {
return paypalTransactionCount;
}
public void setPaypalTransactionCount(Long paypalTransactionCount) {
this.paypalTransactionCount = paypalTransactionCount;
}
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_Billing_Order service controls the orders that are created whenever a SoftLayer customer's places a purchase. Orders exist in several states. The ones of concern are:
* *'''QUOTE_PENDING''': Orders which have not been paid yet. Orders pending approval from a Softlayer customer.
*
*
* Once an order is paid it moves from QUOTE_PENDING to PENDING_APPROVAL state.
*
* Orders are created with contact information duplicated from the [[SoftLayer_Account (type)|SoftLayer_Account data type]] or by manual entry. We do this in order to maintain a history of an account's contact information as orders are generated.
*
* Query the [[SoftLayer_Account]] service to get a list of orders for your account.
*
* @see SoftLayer_Billing_Order
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Billing_Order")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* When an order has been modified, the customer will need to approve the changes. This method will allow the customer to approve the changes.
*
* @see SoftLayer_Billing_Order::approveModifiedOrder
*/
@ApiMethod(instanceRequired = true)
public Boolean approveModifiedOrder();
/**
* This will get all billing orders for your account.
*
* @see SoftLayer_Billing_Order::getAllObjects
*/
@ApiMethod
public List getAllObjects();
/**
* getObject retrieves the SoftLayer_Billing_Order object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Order service. You can only retrieve orders that are assigned to your portal user's account.
*
* @see SoftLayer_Billing_Order::getObject
*/
@ApiMethod(instanceRequired = true)
public Order getObject();
/**
* Get a list of [[SoftLayer_Container_Billing_Order_Status]] objects.
*
* @see SoftLayer_Billing_Order::getOrderStatuses
*/
@ApiMethod
public List getOrderStatuses();
/**
* Retrieve a PDF record of a SoftLayer quote. If the order is not a quote, an error will be thrown.
*
* @see SoftLayer_Billing_Order::getPdf
*/
@ApiMethod(instanceRequired = true)
public byte[] getPdf();
/**
* Retrieve the default filename of an order PDF.
*
* @see SoftLayer_Billing_Order::getPdfFilename
*/
@ApiMethod(instanceRequired = true)
public String getPdfFilename();
/**
* Generate an [[SoftLayer_Container_Product_Order|order container]] from a billing order. This will take into account promotions, reseller status, estimated taxes and all other standard order verification processes.
*
* @see SoftLayer_Billing_Order::getRecalculatedOrderContainer
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.container.product.Order getRecalculatedOrderContainer(String message, Boolean ignoreDiscountsFlag);
/**
* Generate a [[SoftLayer_Container_Product_Order_Receipt]] object with all the order information.
*
* @see SoftLayer_Billing_Order::getReceipt
*/
@ApiMethod(instanceRequired = true)
public Receipt getReceipt();
/**
* When an order has been modified, it will contain a status indicating so. This method checks that status and also verifies that the active user's account is the same as the account on the order.
*
* @see SoftLayer_Billing_Order::isPendingEditApproval
*/
@ApiMethod(instanceRequired = true)
public Boolean isPendingEditApproval();
/**
* The [[SoftLayer_Account|account]] to which an order belongs.
*
* @see SoftLayer_Billing_Order::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* @see SoftLayer_Billing_Order::getBrand
*/
@ApiMethod(instanceRequired = true)
public Brand getBrand();
/**
* A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See [[SoftLayer_Billing_Order_Cart]] for more information.
*
* @see SoftLayer_Billing_Order::getCart
*/
@ApiMethod(instanceRequired = true)
public Cart getCart();
/**
* The [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restricted
*
* @see SoftLayer_Billing_Order::getCoreRestrictedItems
*/
@ApiMethod(instanceRequired = true)
public List- getCoreRestrictedItems();
/**
* All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.
*
* @see SoftLayer_Billing_Order::getCreditCardTransactions
*/
@ApiMethod(instanceRequired = true)
public List
getCreditCardTransactions();
/**
* @see SoftLayer_Billing_Order::getExchangeRate
*/
@ApiMethod(instanceRequired = true)
public ExchangeRate getExchangeRate();
/**
* @see SoftLayer_Billing_Order::getInitialInvoice
*/
@ApiMethod(instanceRequired = true)
public Invoice getInitialInvoice();
/**
* The SoftLayer_Billing_Order_items included in an order.
*
* @see SoftLayer_Billing_Order::getItems
*/
@ApiMethod(instanceRequired = true)
public List- getItems();
/**
* @see SoftLayer_Billing_Order::getOrderApprovalDate
*/
@ApiMethod(instanceRequired = true)
public GregorianCalendar getOrderApprovalDate();
/**
* An order's non-server items total monthly fee.
*
* @see SoftLayer_Billing_Order::getOrderNonServerMonthlyAmount
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOrderNonServerMonthlyAmount();
/**
* An order's server items total monthly fee.
*
* @see SoftLayer_Billing_Order::getOrderServerMonthlyAmount
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOrderServerMonthlyAmount();
/**
* An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.
*
* @see SoftLayer_Billing_Order::getOrderTopLevelItems
*/
@ApiMethod(instanceRequired = true)
public List
- getOrderTopLevelItems();
/**
* This amount represents the order's initial charge including set up fee and taxes.
*
* @see SoftLayer_Billing_Order::getOrderTotalAmount
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOrderTotalAmount();
/**
* An order's total one time amount summing all the set up fees, the labor fees and the one time fees. Taxes will be applied for non-tax-exempt. This amount represents the initial fees that will be charged.
*
* @see SoftLayer_Billing_Order::getOrderTotalOneTime
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOrderTotalOneTime();
/**
* An order's total one time amount. This amount represents the initial fees before tax.
*
* @see SoftLayer_Billing_Order::getOrderTotalOneTimeAmount
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOrderTotalOneTimeAmount();
/**
* An order's total one time tax amount. This amount represents the tax that will be applied to the total charge, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.
*
* @see SoftLayer_Billing_Order::getOrderTotalOneTimeTaxAmount
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOrderTotalOneTimeTaxAmount();
/**
* An order's total recurring amount. Taxes will be applied for non-tax-exempt. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
*
* @see SoftLayer_Billing_Order::getOrderTotalRecurring
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOrderTotalRecurring();
/**
* An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis.
*
* @see SoftLayer_Billing_Order::getOrderTotalRecurringAmount
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOrderTotalRecurringAmount();
/**
* The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.
*
* @see SoftLayer_Billing_Order::getOrderTotalRecurringTaxAmount
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOrderTotalRecurringTaxAmount();
/**
* An order's total setup fee.
*
* @see SoftLayer_Billing_Order::getOrderTotalSetupAmount
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOrderTotalSetupAmount();
/**
* The type of an order. This lets you know where this order was generated from.
*
* @see SoftLayer_Billing_Order::getOrderType
*/
@ApiMethod(instanceRequired = true)
public Type getOrderType();
/**
* All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.
*
* @see SoftLayer_Billing_Order::getPaypalTransactions
*/
@ApiMethod(instanceRequired = true)
public List
getPaypalTransactions();
/**
* @see SoftLayer_Billing_Order::getPresaleEvent
*/
@ApiMethod(instanceRequired = true)
public Event getPresaleEvent();
/**
* The quote of an order. This quote holds information about its expiration date, creation date, name and status. This information is tied to an order having the status 'QUOTE'
*
* @see SoftLayer_Billing_Order::getQuote
*/
@ApiMethod(instanceRequired = true)
public Quote getQuote();
/**
* The Referral Partner who referred this order. (Only necessary for new customer orders)
*
* @see SoftLayer_Billing_Order::getReferralPartner
*/
@ApiMethod(instanceRequired = true)
public Account getReferralPartner();
/**
* This flag indicates an order is an upgrade.
*
* @see SoftLayer_Billing_Order::getUpgradeRequestFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getUpgradeRequestFlag();
/**
* The SoftLayer_User_Customer object tied to an order.
*
* @see SoftLayer_Billing_Order::getUserRecord
*/
@ApiMethod(instanceRequired = true)
public Customer getUserRecord();
}
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#approveModifiedOrder}
*/
public Future approveModifiedOrder();
public Future approveModifiedOrder(ResponseHandler callback);
/**
* Async version of {@link Service#getAllObjects}
*/
public Future> getAllObjects();
public Future getAllObjects(ResponseHandler> callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future getObject(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderStatuses}
*/
public Future> getOrderStatuses();
public Future getOrderStatuses(ResponseHandler> callback);
/**
* Async version of {@link Service#getPdf}
*/
public Future getPdf();
public Future getPdf(ResponseHandler callback);
/**
* Async version of {@link Service#getPdfFilename}
*/
public Future getPdfFilename();
public Future getPdfFilename(ResponseHandler callback);
/**
* Async version of {@link Service#getRecalculatedOrderContainer}
*/
public Future getRecalculatedOrderContainer(String message, Boolean ignoreDiscountsFlag);
public Future getRecalculatedOrderContainer(String message, Boolean ignoreDiscountsFlag, ResponseHandler callback);
/**
* Async version of {@link Service#getReceipt}
*/
public Future getReceipt();
public Future getReceipt(ResponseHandler callback);
/**
* Async version of {@link Service#isPendingEditApproval}
*/
public Future isPendingEditApproval();
public Future isPendingEditApproval(ResponseHandler callback);
/**
* Async version of {@link Service#getAccount}
*/
public Future getAccount();
/**
* Async callback version of {@link Service#getAccount}
*/
public Future getAccount(ResponseHandler callback);
/**
* Async version of {@link Service#getBrand}
*/
public Future getBrand();
/**
* Async callback version of {@link Service#getBrand}
*/
public Future getBrand(ResponseHandler callback);
/**
* Async version of {@link Service#getCart}
*/
public Future getCart();
/**
* Async callback version of {@link Service#getCart}
*/
public Future getCart(ResponseHandler callback);
/**
* Async version of {@link Service#getCoreRestrictedItems}
*/
public Future> getCoreRestrictedItems();
/**
* Async callback version of {@link Service#getCoreRestrictedItems}
*/
public Future getCoreRestrictedItems(ResponseHandler> callback);
/**
* Async version of {@link Service#getCreditCardTransactions}
*/
public Future> getCreditCardTransactions();
/**
* Async callback version of {@link Service#getCreditCardTransactions}
*/
public Future getCreditCardTransactions(ResponseHandler> callback);
/**
* Async version of {@link Service#getExchangeRate}
*/
public Future getExchangeRate();
/**
* Async callback version of {@link Service#getExchangeRate}
*/
public Future getExchangeRate(ResponseHandler callback);
/**
* Async version of {@link Service#getInitialInvoice}
*/
public Future getInitialInvoice();
/**
* Async callback version of {@link Service#getInitialInvoice}
*/
public Future getInitialInvoice(ResponseHandler callback);
/**
* Async version of {@link Service#getItems}
*/
public Future> getItems();
/**
* Async callback version of {@link Service#getItems}
*/
public Future getItems(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#getOrderNonServerMonthlyAmount}
*/
public Future getOrderNonServerMonthlyAmount();
/**
* Async callback version of {@link Service#getOrderNonServerMonthlyAmount}
*/
public Future getOrderNonServerMonthlyAmount(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderServerMonthlyAmount}
*/
public Future getOrderServerMonthlyAmount();
/**
* Async callback version of {@link Service#getOrderServerMonthlyAmount}
*/
public Future getOrderServerMonthlyAmount(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderTopLevelItems}
*/
public Future> getOrderTopLevelItems();
/**
* Async callback version of {@link Service#getOrderTopLevelItems}
*/
public Future getOrderTopLevelItems(ResponseHandler> callback);
/**
* Async version of {@link Service#getOrderTotalAmount}
*/
public Future getOrderTotalAmount();
/**
* Async callback version of {@link Service#getOrderTotalAmount}
*/
public Future getOrderTotalAmount(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderTotalOneTime}
*/
public Future getOrderTotalOneTime();
/**
* Async callback version of {@link Service#getOrderTotalOneTime}
*/
public Future getOrderTotalOneTime(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderTotalOneTimeAmount}
*/
public Future getOrderTotalOneTimeAmount();
/**
* Async callback version of {@link Service#getOrderTotalOneTimeAmount}
*/
public Future getOrderTotalOneTimeAmount(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderTotalOneTimeTaxAmount}
*/
public Future getOrderTotalOneTimeTaxAmount();
/**
* Async callback version of {@link Service#getOrderTotalOneTimeTaxAmount}
*/
public Future getOrderTotalOneTimeTaxAmount(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderTotalRecurring}
*/
public Future getOrderTotalRecurring();
/**
* Async callback version of {@link Service#getOrderTotalRecurring}
*/
public Future getOrderTotalRecurring(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderTotalRecurringAmount}
*/
public Future getOrderTotalRecurringAmount();
/**
* Async callback version of {@link Service#getOrderTotalRecurringAmount}
*/
public Future getOrderTotalRecurringAmount(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderTotalRecurringTaxAmount}
*/
public Future getOrderTotalRecurringTaxAmount();
/**
* Async callback version of {@link Service#getOrderTotalRecurringTaxAmount}
*/
public Future getOrderTotalRecurringTaxAmount(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderTotalSetupAmount}
*/
public Future getOrderTotalSetupAmount();
/**
* Async callback version of {@link Service#getOrderTotalSetupAmount}
*/
public Future getOrderTotalSetupAmount(ResponseHandler callback);
/**
* Async version of {@link Service#getOrderType}
*/
public Future getOrderType();
/**
* Async callback version of {@link Service#getOrderType}
*/
public Future getOrderType(ResponseHandler callback);
/**
* Async version of {@link Service#getPaypalTransactions}
*/
public Future> getPaypalTransactions();
/**
* Async callback version of {@link Service#getPaypalTransactions}
*/
public Future getPaypalTransactions(ResponseHandler> callback);
/**
* Async version of {@link Service#getPresaleEvent}
*/
public Future getPresaleEvent();
/**
* Async callback version of {@link Service#getPresaleEvent}
*/
public Future getPresaleEvent(ResponseHandler callback);
/**
* Async version of {@link Service#getQuote}
*/
public Future getQuote();
/**
* Async callback version of {@link Service#getQuote}
*/
public Future getQuote(ResponseHandler callback);
/**
* Async version of {@link Service#getReferralPartner}
*/
public Future getReferralPartner();
/**
* Async callback version of {@link Service#getReferralPartner}
*/
public Future getReferralPartner(ResponseHandler callback);
/**
* Async version of {@link Service#getUpgradeRequestFlag}
*/
public Future getUpgradeRequestFlag();
/**
* Async callback version of {@link Service#getUpgradeRequestFlag}
*/
public Future getUpgradeRequestFlag(ResponseHandler callback);
/**
* Async version of {@link Service#getUserRecord}
*/
public Future getUserRecord();
/**
* Async callback version of {@link Service#getUserRecord}
*/
public Future getUserRecord(ResponseHandler callback);
}
public static class Mask extends com.softlayer.api.service.Entity.Mask {
public com.softlayer.api.service.Account.Mask account() {
return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
}
public com.softlayer.api.service.Brand.Mask brand() {
return withSubMask("brand", com.softlayer.api.service.Brand.Mask.class);
}
public com.softlayer.api.service.billing.order.Cart.Mask cart() {
return withSubMask("cart", com.softlayer.api.service.billing.order.Cart.Mask.class);
}
public com.softlayer.api.service.billing.order.Item.Mask coreRestrictedItems() {
return withSubMask("coreRestrictedItems", com.softlayer.api.service.billing.order.Item.Mask.class);
}
public com.softlayer.api.service.billing.payment.card.Transaction.Mask creditCardTransactions() {
return withSubMask("creditCardTransactions", com.softlayer.api.service.billing.payment.card.Transaction.Mask.class);
}
public com.softlayer.api.service.billing.currency.ExchangeRate.Mask exchangeRate() {
return withSubMask("exchangeRate", com.softlayer.api.service.billing.currency.ExchangeRate.Mask.class);
}
public Invoice.Mask initialInvoice() {
return withSubMask("initialInvoice", Invoice.Mask.class);
}
public com.softlayer.api.service.billing.order.Item.Mask items() {
return withSubMask("items", com.softlayer.api.service.billing.order.Item.Mask.class);
}
public Mask orderApprovalDate() {
withLocalProperty("orderApprovalDate");
return this;
}
public Mask orderNonServerMonthlyAmount() {
withLocalProperty("orderNonServerMonthlyAmount");
return this;
}
public Mask orderServerMonthlyAmount() {
withLocalProperty("orderServerMonthlyAmount");
return this;
}
public com.softlayer.api.service.billing.order.Item.Mask orderTopLevelItems() {
return withSubMask("orderTopLevelItems", com.softlayer.api.service.billing.order.Item.Mask.class);
}
public Mask orderTotalAmount() {
withLocalProperty("orderTotalAmount");
return this;
}
public Mask orderTotalOneTime() {
withLocalProperty("orderTotalOneTime");
return this;
}
public Mask orderTotalOneTimeAmount() {
withLocalProperty("orderTotalOneTimeAmount");
return this;
}
public Mask orderTotalOneTimeTaxAmount() {
withLocalProperty("orderTotalOneTimeTaxAmount");
return this;
}
public Mask orderTotalRecurring() {
withLocalProperty("orderTotalRecurring");
return this;
}
public Mask orderTotalRecurringAmount() {
withLocalProperty("orderTotalRecurringAmount");
return this;
}
public Mask orderTotalRecurringTaxAmount() {
withLocalProperty("orderTotalRecurringTaxAmount");
return this;
}
public Mask orderTotalSetupAmount() {
withLocalProperty("orderTotalSetupAmount");
return this;
}
public com.softlayer.api.service.billing.order.Type.Mask orderType() {
return withSubMask("orderType", com.softlayer.api.service.billing.order.Type.Mask.class);
}
public com.softlayer.api.service.billing.payment.paypal.Transaction.Mask paypalTransactions() {
return withSubMask("paypalTransactions", com.softlayer.api.service.billing.payment.paypal.Transaction.Mask.class);
}
public com.softlayer.api.service.sales.presale.Event.Mask presaleEvent() {
return withSubMask("presaleEvent", com.softlayer.api.service.sales.presale.Event.Mask.class);
}
public com.softlayer.api.service.billing.order.Quote.Mask quote() {
return withSubMask("quote", com.softlayer.api.service.billing.order.Quote.Mask.class);
}
public com.softlayer.api.service.Account.Mask referralPartner() {
return withSubMask("referralPartner", com.softlayer.api.service.Account.Mask.class);
}
public Mask upgradeRequestFlag() {
withLocalProperty("upgradeRequestFlag");
return this;
}
public com.softlayer.api.service.user.Customer.Mask userRecord() {
return withSubMask("userRecord", com.softlayer.api.service.user.Customer.Mask.class);
}
public Mask accountId() {
withLocalProperty("accountId");
return this;
}
public Mask createDate() {
withLocalProperty("createDate");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask impersonatingUserRecordId() {
withLocalProperty("impersonatingUserRecordId");
return this;
}
public Mask modifyDate() {
withLocalProperty("modifyDate");
return this;
}
public Mask orderQuoteId() {
withLocalProperty("orderQuoteId");
return this;
}
public Mask orderTypeId() {
withLocalProperty("orderTypeId");
return this;
}
public Mask presaleEventId() {
withLocalProperty("presaleEventId");
return this;
}
public Mask privateCloudOrderFlag() {
withLocalProperty("privateCloudOrderFlag");
return this;
}
public Mask status() {
withLocalProperty("status");
return this;
}
public Mask userRecordId() {
withLocalProperty("userRecordId");
return this;
}
public Mask coreRestrictedItemCount() {
withLocalProperty("coreRestrictedItemCount");
return this;
}
public Mask creditCardTransactionCount() {
withLocalProperty("creditCardTransactionCount");
return this;
}
public Mask itemCount() {
withLocalProperty("itemCount");
return this;
}
public Mask orderTopLevelItemCount() {
withLocalProperty("orderTopLevelItemCount");
return this;
}
public Mask paypalTransactionCount() {
withLocalProperty("paypalTransactionCount");
return this;
}
}
}