public class SalesContainer extends Session
Modifier and Type | Field and Description |
---|---|
static java.lang.String | CREATE_MODE
Constant for the order editor create mode.
|
static java.lang.String | EDIT_MODE
Constant for the order editor edit mode.
|
java.lang.String | pickupInStoreValue |
static java.lang.String | PROP_ADDED_ITEMS
Constant for the added items property name.
|
static java.lang.String | PROP_APPLIED_ORDER_PROMOTION_CODES
Constant for the applied promotions on an order.The value is "appliedOrderPromotionCodes".
|
static java.lang.String | PROP_AVAILABLE_BILLING_ADDRESSES
Constant for the available billing addresses of a payment method property name prefix.
|
static java.lang.String | PROP_AVAILABLE_PAYMENT
Constant for the available payments property name prefix.
|
static java.lang.String | PROP_AVAILABLE_PAYMENT_ATTRIBUTES
Constant for the available payments attributes property name prefix.
|
static java.lang.String | PROP_AVILABLE_NEXT_TIE_CODE
Constant for the available tie code.
|
static java.lang.String | PROP_BUSINESS_CHANNEL
Constant for the business channel property name.
|
static java.lang.String | PROP_CACHED_ADDRESSES
Constant for the cached addresses property name.
|
static java.lang.String | PROP_CACHED_PRODUCTS
Constant for the cached products property name.
|
static java.lang.String | PROP_CHECK_ORDER_LOCK
Constant for checkLock property name.
|
static java.lang.String | PROP_CLOSING
Constant for the Closing property name.
|
static java.lang.String | PROP_COMMENTS
Constant for the cached sales container comments.
|
static java.lang.String | PROP_CONFIRM_VIA_EMAIL
Constant for the confirm via email property name.
|
static java.lang.String | PROP_CONTAINER_ID
Constant for the container ID property name.
|
static java.lang.String | PROP_CURRENCY_CODE
Constant for the currency code property name.
|
static java.lang.String | PROP_CURRENT_CHARGE_DISCOUNT_AMOUNT
Constant for the tax property name prefix.
|
static java.lang.String | PROP_CURRENT_CHARGE_EXTENDED_PRICE
Constant for the extended price property name.
|
static java.lang.String | PROP_CURRENT_CHARGE_SHIPPING_AMOUNT
Constant for the tax property name prefix.
|
static java.lang.String | PROP_CURRENT_CHARGE_TAX_AMOUNT
Deprecated.
This property name has been deprecated. Use alternate property PROP_CURRENT_TAX
|
static java.lang.String | PROP_CURRENT_CHARGE_TOTAL_AMOUNT
Constant for the tax property name prefix.
|
static java.lang.String | PROP_CURRENT_TAX
Constant for the current tax property name prefix.
|
static java.lang.String | PROP_CURRENT_TIE_CODE
Constant for the current tie code property name.
|
static java.lang.String | PROP_CUSTOMERS_EMAIL_ADDRESS
Constant for the Customer's E-mail address.
|
static java.lang.String | PROP_DATE_PLACED
Constant for the date placed property name.
|
static java.lang.String | PROP_DATE_TIME_LAST_MODIFIED
Constant for the date/time last modified property name.
|
static java.lang.String | PROP_DELETED_ITEMS
Constant for the deleted items property name.
|
static java.lang.String | PROP_DISCOUNT_AMOUNT
Constant for the discount amount property name.
|
static java.lang.String | PROP_EDITOR_ID
Constant for the editor ID property name.
|
static java.lang.String | PROP_EDITOR_LOGON_ID
Constant for the editor logon ID property name.
|
static java.lang.String | PROP_EXPIRE_DATE
Constant for the Quote Expire Date property name.
|
static java.lang.String | PROP_EXTENDED_PRICE
Constant for the extended price property name.
|
static java.lang.String | PROP_IS_AUTO_PAYMENT
Constant for the auto payment addition property name.
|
static java.lang.String | PROP_IS_EMPTY
Constant used to identify whether is empty (value "isEmpty").
|
java.lang.String | PROP_IS_PICKUP_IN_STORE |
static java.lang.String | PROP_IS_PREPARED
Constant for the order prepared property name.
|
static java.lang.String | PROP_ITEM
Constant for the item property name prefix.
|
static java.lang.String | PROP_ITEMS
Constant for the items property.
|
static java.lang.String | PROP_MISCELLANEOUS_CHARGE
Constant for the miscellaneous charge property name prefix.
|
static java.lang.String | PROP_NEW_VERSION_GENERATED
Constant for the NEW_VERSION_GENERATED property name.
|
static java.lang.String | PROP_NOTIFY_CUSTOMER
Constant for notify customer via Email or not.
|
static java.lang.String | PROP_ORDER_BLOCKS
Constant for the order blocks property name.
|
static java.lang.String | PROP_ORDER_COMMENT
Constant for the order comment.
|
static java.lang.String | PROP_ORDER_EDITABLE_STATUS
Constant for the order editable status.
|
static java.lang.String | PROP_ORDER_HISTORY_EXISTED
Constant for the order history existed flag.
|
static java.lang.String | PROP_ORDER_LOCKED
Constant for the order lock property name.
|
static java.lang.String | PROP_ORDER_MODE
Constant for the order editor mode type.
|
static java.lang.String | PROP_ORDER_PENDING_APPROVAL_STATUS
Constant for the order approval pending status.
|
static java.lang.String | PROP_ORDER_UNPAID_BALANCE
Constant for the unpaid balance property name prefix.
|
static java.lang.String | PROP_ORDER_VERSION
Constant for the ORDER_VERSION property name.
|
static java.lang.String | PROP_ORDER_VERSIONS
Constant for the orderVersions property name.
|
static java.lang.String | PROP_ORDERCHANGE_INFORMATION_LIST
Constant for the PROP_ORDERCHANGE_INFORMATION_LIST property name.
|
static java.lang.String | PROP_ORDERCHANGE_REASONS_LIST
Constant for the ORDERCHANGE_REASONS_LIST property name.
|
static java.lang.String | PROP_ORDERING_CUSTOMER
Constant for the ordering customer property name.
|
static java.lang.String | PROP_ORGANIZATION
Constant for the organization associated with order or quote.
|
static java.lang.String | PROP_PAYING_CUSTOMER
Constant for the paying customer property name.
|
static java.lang.String | PROP_PAYMENT
Constant for the payment property name prefix.
|
static java.lang.String | PROP_PAYMENTS
Constant for the payments property.
|
static java.lang.String | PROP_PERFORM_PAYMENT_REFUND
Constant for the payment refund force flag.
|
static java.lang.String | PROP_PO_NUMBER
Constant for the purchase order number.
|
static java.lang.String | PROP_PO_NUMBER_REQUIRED
Constant for the purchase order number required indicator.
|
static java.lang.String | PROP_PROMOTION_CODE_APPLICABLE
Constant for the Promotion code applicable flag.
|
static java.lang.String | PROP_QUOTE_EXPIRY_PERIOD
Constant for the Maximum Quote Expiry Period property name.
|
static java.lang.String | PROP_REQUIRE_PREPARATION
Constant for the order requirePreparation property name.
|
static java.lang.String | PROP_SHIP_AS_COMPLETE
Constant for the ship as complete property name.
|
static java.lang.String | PROP_SHIP_MODES
Constant for the shipping modes property name.
|
static java.lang.String | PROP_SHIP_TO_CUSTOMERS
Constant for the ship to customers property name.
|
static java.lang.String | PROP_SHIPPING_INFO
Constant for the tax property name prefix.
|
static java.lang.String | PROP_STATUS
Constant for the order status property name.
|
static java.lang.String | PROP_STATUS_LABEL
Constant for the order status label property name.
|
static java.lang.String | PROP_STORE_DESCRIPTION
Constant for the store description property name.
|
static java.lang.String | PROP_STORE_ID
Constant for the store ID property name.
|
static java.lang.String | PROP_TAKE_OVER_ORDER
Constant for the order take over property name.
|
static java.lang.String | PROP_TAX
Constant for the tax property name prefix.
|
static java.lang.String | PROP_TOTAL_AMOUNT
Constant for the total amount property name.
|
static java.lang.String | PROP_TRANSPORTATION_CHARGE
Constant for the transportation charge property name.
|
static java.lang.String | PROP_TYPE
Constant for the SalesContainer type.
|
static java.lang.String | PROP_UNIQUE_ID
Constant for the unique ID property name.
|
static java.lang.String | STATUS_NONE
Status constant (value "NONE") which identifies sales container's status.
|
static java.lang.String | STATUS_ORDER_AUTH_ALLOWED
Status constant (value "M") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_BACKORDERED
Status constant (value "B") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_CANCELED
Status constant (value "X") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_COMPLETED
Status constant (value "C") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_DENIED
Status constant (value "N") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_DEPOSITED
Status constant (value "D") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_EDITED
Status constant (value "E") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_INV_UPDATE_FAILED
Status constant (value "L") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_PAYMENT_AUTH_REVIEW
Status constant (value "A") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_PENDING
Status constant (value "P") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_PENDING_REMOTE_FULFILLMENT
Status constant (value "G") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_PROFILE
Status constant (value "Q") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_READY_FOR_REMOTE_FULFILLMENT
Status constant (value "F") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_RELEASED
Status constant (value "R") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_REMOTE_FULFILLMENT_FAILED
Status constant (value "H") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_SHIPPED
Status constant (value "S") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_SUBMITTED
Status constant (value "I") which identifies an Order's status.
|
static java.lang.String | STATUS_ORDER_WAITING_APPROVAL
Status constant (value "W") which identifies an Order's status.
|
static java.lang.String | STATUS_QUOTE_CANCELED
Status constant (value "CAN") which identifies a Quote's status.
|
static java.lang.String | STATUS_QUOTE_NEW
Status constant (value "NEW") which identifies a Quote's status.
|
static java.lang.String | STATUS_QUOTE_READY
Status constant (value "RDY") which identifies a Quote's status.
|
static java.lang.String | STATUS_READ
Status constant (value "READ") which identifies an old order version's status.
|
static java.lang.String | STATUS_REQUISITION_LIST_PRIVATE
Status constant (value "Y") which identifies an Order's status.
|
static java.lang.String | STATUS_REQUISITION_LIST_SHAREABLE
Status constant (value "Z") which identifies an Order's status.
|
static java.lang.String | STATUS_TEMPORARY
Status constant (value "T") which identifies an Order's status.
|
static java.lang.String | TYPE_ORDER
Constant used to identify order type (value "ORDER").
|
static java.lang.String | TYPE_QUOTE
Constant used to identify quote type (value "QUOTE").
|
Constructor and Description |
---|
SalesContainer()
Constructor for Order.
|
Modifier and Type | Method and Description |
---|---|
void | addAvailablePayment(java.lang.String paymentMethodId)
This method is a convenience method for setting an "availablePayment." property.
|
void | addCachedAddress(Address address)
This method is a convenience method for updating the cachedAddresses property.
|
void | addCachedProduct(Product product)
This method is a convenience method for updating the cachedProducts property.
|
void | addComment(SalesContainerComment comment)
This method is a convenience method for updating the "salesContainerComment" property.
|
void | addCurrentTaxAmount(java.lang.String charge, java.lang.String taxAmount)
This method is a convenience method for setting a "currentTax." property.
|
void | addItem(Line item)
This method is a convenience method for setting an "item." property.
|
void | addMiscellaneousCharge(MiscellaneousCharge miscellaneousCharge)
This method is a convenience method for setting an "miscellaneousCharge." property.
|
void | addOrderChangeInfo(OrderHistoryInformation orderChangeInfo)
This method adds the order change information.
|
void | addOrderVersionObject(OrderVersion orderVersion) |
void | addPayment(Payment payment)
This method is a convenience method for setting an "payment." property.
|
void | addShipMode(ShippingMode shippingMode)
This method adds a Shipping Mode to the order
|
void | addTaxAmount(java.lang.String charge, java.lang.String taxAmount)
This method is a convenience method for setting a "tax." property.
|
boolean | canAddPayment()
This method is a convenience method to check if a new payment method can be added to the order.
|
boolean | checkLock()
This method is a convenience method for retrieving the current setting of the "checkLock" property.
|
void | clearAddressCache()
This method is a convenience method for updating the cachedAddresses property.
|
void | clearComments()
This method is a convenience method for clearing the "salesContainerComment" property.
|
void | clearOrderVersions()
This method clears the OrderVersion objects available in sales container.
|
void | clearProductCache()
This method is a convenience method for updating the cachedProducts property.
|
protected int | compareDates(java.lang.Object e1, java.lang.Object e2)
Returns a number reflecting the collation order of the given editable based on their values.
|
Address | findCachedAddress(java.lang.String addressId)
This method is a convenience method for accessing the cachedAddresses property.
|
Product | findCachedProduct(java.lang.String catalogEntryId)
This method is a convenience method for accessing the cachedProducts property.
|
protected void | fireModelObjectChangedEvent(java.lang.String propertyName, java.lang.Object oldData, java.lang.Object newData)
This method fires events when new items are added or any existing items are removed.
|
ModelObjectList | getAppliedOrderPromotionCodes()
Returns the promotion codes contained in this object as a ModelObjectList of "OrderPromotionCode" object.
|
Address[] | getAvailablePaymentAddresses(java.lang.String paymentMethodId)
This method is a convenience method for retrieving the current setting of all of the "availableBillingAddresses." properties.
|
Payment | getAvailablePaymentAttributes(java.lang.String paymentMethodId)
This method is a convenience method for setting an "availablePaymentAttributes." property.
|
java.lang.String[] | getAvailablePayments()
This method is a convenience method for retrieving the current setting of all of the "availablePayment." properties.
|
java.lang.String | getAvailableTieCode()
This method is a convenience method for retrieving available tie code.
|
BusinessChannel | getBusinessChannel()
This is a convenience method for retrieving the BusinessChannel of this order.
|
java.util.Hashtable | getCachedAddresses()
This method is a convenience method for retrieving the current setting of the "cachedAddresses" property.
|
java.util.Hashtable | getCachedProducts()
This method is a convenience method for retrieving the current setting of the "cachedProducts" property.
|
boolean | getClosing()
This method is a convenience method for retrieving the current setting of the "Closing" property.
|
SalesContainerComment[] | getComments()
This method is a convenience method for retrieving the current setting of the "salesContainerComment" property.
|
boolean | getConfirmViaEmail()
This method is a convenience method for retrieving whether to confirm via email.
|
java.lang.String | getContainerId()
This method is a convenience method for retrieving the current setting of the "containerId" property.
|
OrderBlock[] | getCopyOfOrderBlocks()
This is a convenience method for retrieving the array of OrderBlocks to this order.
|
java.lang.String | getCurrencyCode()
This method is a convenience method for retrieving the current setting of the "currencyCode" property.
|
java.lang.String | getCurrentChargeDiscountAmount()
This method is a convenience method for retrieving the current setting of the "currentChargeDiscountAmount" property.
|
java.lang.String | getCurrentChargeExtendedPrice()
This method is a convenience method for retrieving the current setting of the "currentChargeExtendedPrice" property.
|
java.lang.String | getCurrentChargeShippingAmount()
This method is a convenience method for retrieving the current setting of the "currentChargeShippingAmount" property.
|
java.lang.String | getCurrentChargeTaxAmount()
This method is a convenience method for retrieving the current setting of all of the "currentTax." properties.
|
java.lang.String | getCurrentChargeTotalAmount()
This method is a convenience method for retrieving the current setting of the "currentChargeTotalAmount" property.
|
java.lang.String | getCurrentTaxAmount(java.lang.String charge)
This method is a convenience method for retrieving the current setting of a "currentTax." property.
|
java.lang.String | getCurrentTieCode()
This method is a convenience method for retrieving the current setting of the "currentTieCode" property.
|
java.lang.String | getCustomersEmailAddress()
This method is a convenience method for retrieving the current setting of the "customersEmailAddress" property.
|
java.lang.String | getDatePlaced()
This method is a convenience method for retrieving the current setting of the "datePlaced" property.
|
java.lang.String | getDateTimeLastModified()
This method is a convenience method for retrieving the current setting of the "dateTimeLastModified" property.
|
java.lang.String | getDiscountAmount()
This method is a convenience method for retrieving the current setting of the "discountAmount" property.
|
java.lang.String | getEditorId()
This method is a convenience method for retrieving the current setting of the "editorId" property.
|
java.lang.String | getEditorLogonId()
This method is a convenience method for retrieving the current setting of the "editorLogonId" property.
|
java.lang.String | getEditorMode()
Returns the mode in which order editor is to operate.
|
java.lang.String | getExpireDate()
This method is a convenience method for retrieving the current setting of the "ExpireDate" property.
|
java.lang.String | getExtendedPrice()
This method is a convenience method for retrieving the current setting of the "extendedPrice" property.
|
Line | getItem(java.lang.String lineNumber)
This method is a convenience method for retrieving the current setting of an "item." property.
|
Line[] | getItems()
This method is a convenience method for retrieving the current setting of all of the "item." properties.
|
ModelObjectList | getItemsModelObjectList()
This method is a convenience method for retrieving the current setting of the "items" property.
|
MiscellaneousCharge[] | getMiscellaneousCharges()
This method is a convenience method for retrieving the current setting of all of the "miscellaneousCharge." properties.
|
java.lang.String | getNewVersionGenerated() |
java.lang.String | getNotifyCustomer()
This method is a convenience method for retrieving the current setting of the "sendEmailNotification" property.
|
int | getNumberOfActiveBlocks()
This is a convenience method for determining how many active blocks are associated with this order.
|
OrderBlock[] | getOrderBlocks()
This is a convenience method for retrieving the array of OrderBlocks to this order.
|
java.util.List | getOrderChangeReasons() |
java.util.List | getOrderChanges() |
java.lang.String | getOrderComment()
This method is a convenience method for retrieving the current setting of the "orderComment" property.
|
Customer | getOrderingCustomer()
This method is a convenience method for retrieving the current setting of the "orderingCustomer" property.
|
java.lang.String | getOrderUnpaidBalance()
This method is a convenience method for retrieving the current setting of the "orderUnpaidBalance" property.
|
java.lang.String | getOrderVersion() |
ModelObjectList | getOrderVersions() |
Organization | getOrganization()
This method is a convenience method for retrieving the current setting of the "organization" property.
|
Customer | getPayingCustomer()
This method is a convenience method for retrieving the current setting of the "payingCustomer" property.
|
Payment | getPayment(java.lang.String paymentNumber)
This method is a convenience method for retrieving the current setting of an "payment." property.
|
Payment[] | getPayments()
This method is a convenience method for retrieving the current setting of all of the "payment." properties.
|
ModelObjectList | getPaymentsModelObjectList()
This method is a convenience method for retrieving the current setting of the "payments" property.
|
java.lang.String | getPerformPaymentRefund()
This method is a convenience method for retrieving the current setting of the "performPaymentRefund" property.
|
java.lang.String | getPONumber()
This method returns the purchase order number associated with this sales container
|
java.lang.String | getQuoteExpiryPeriod()
This method is a convenience method for retrieving the current setting of the "MaxQuoteExpiryPeriod" property.
|
ModelObjectList | getSalesContainerComment()
This method is a convenience method for retrieving the current setting of the PROP_COMMENTS property.
|
ShippingMode | getShipMode(java.lang.String shippingModeId)
This method retrieve a Shipping Modes from the order base on the ShippingModeId If the specified Shipping Mode is not found, "null" will be return.
|
ShippingMode[] | getShipModes()
This method retrieves all Shipping Modes from the order
|
ShippingInfo | getShippingInfo()
This method is a convenience method for retrieving the current setting of the "shippingInformation" property.
|
Customer[] | getShipToCustomers()
This method is a convenience method for retrieving the current setting of the "shipToCustomers" property.
|
ModelObjectList | getShipToCustomersModelObjectList()
This method is a convenience method for retrieving the current setting of the "shipToCustomers" property.
|
java.lang.String | getStatus()
This method is a convenience method for retrieving the current setting of the "status" property.
|
java.lang.String | getStatusLabel()
Returns a displayable string representation of the status code.
|
java.lang.String | getStoreDescription()
This method is a convenience method for retrieving the current setting of the "storeDescription" property.
|
java.lang.String | getStoreId()
This method is a convenience method for retrieving the current setting of the "storeId" property.
|
java.lang.String | getTaxAmount()
This method is a convenience method for retrieving the current setting of all of the "tax." properties.
|
java.lang.String | getTaxAmount(java.lang.String charge)
This method is a convenience method for retrieving the current setting of a "tax." property.
|
Line[] | getTiedItems(java.lang.String tieCode)
This method is a convenience method for retrieving all line items in the same tie group.
|
java.lang.String | getTotalAmount()
This method is a convenience method for retrieving the current setting of the "totalAmount" property.
|
java.lang.String | getTransportationCharge()
This method is a convenience method for retrieving the current setting of the "transportationCharge" property.
|
java.lang.String | getType()
This method is a convenience method for retrieving the current setting of the "type" property.
|
boolean | hasActiveOperatorEditorId()
This method is a convenience method for determining if the non-null editorId associated with this Order is the same as the Active Operator's id.
|
boolean | hasNonEditableItems()
This method checks to see if the Order has AT LEAST ONE non-editable order item, if so returns 'true' otherwise returns 'false'.
|
boolean | hasTieCode()
This method is a convenience method to determine whether line items contain tie code information.
|
boolean | isApprovalPending()
This method is a convenience method for retrieving the current setting of the "orderApprovalPending" property.
|
boolean | isAutoPayment()
This method is a convenience method for retrieving the current setting of the "isAutoPayment" property.
|
boolean | isBlocked()
This is a convenience method for determining if this order is blocked.
|
boolean | isEditable()
This method is a convenience method for retrieving the current setting of the "orderEditable" property.
|
boolean | isEditEnabled()
This method is an empty implementation for determining if the Container is editable.
|
boolean | isEmpty()
This method returns if order is empty or not.
|
boolean | isHistoryExisted()
This method is a convenience method for retrieving the current setting of the "isLocked" property.
|
boolean | isLocked()
This method is a convenience method for retrieving the current setting of the "isLocked" property.
|
boolean | isPickupInStoreShippingMode()
This method verifies weather the order has pickup-in-store value as YES.
|
boolean | isPONumberRequired()
This method is a convenience method for retrieving the current setting of the "PONumberRequired" property.
|
boolean | isPrepared()
This method is a convenience method for retrieving the current setting of the "isPrepared" property.
|
boolean | isPromotionCodeApplicable()
This method is a convenience method for retrieving the current setting of the "isPromotionCodeApplicable" property.
|
boolean | isRequirePreparation()
This method is a convenience method for retrieving the current setting of the "isPrepared" property.
|
boolean | isShipAsComplete()
This method is a convenience method for retrieving whether the order is marked as ShipAsComplete
|
void | refresh(ModelObject refreshSource)
Refreshes this model object with the properties found in the specified model object.
|
void | removeMiscellaneousCharges()
This method is a convenience method for removing the "miscellaneousCharge." property.
|
void | reset()
This method is a convenience method for removing all of the properties that have a name that starts with "item.".
|
void | setAppliedOrderPromotionCodes(ModelObjectList promotionCodes)
Sets the order promotion codes that is applied on the order.
|
void | setApprovalPendingStatus(java.lang.Boolean orderApprovalPending)
This method is a convenience method for setting the "orderApprovalPending" property.
|
void | setAutoPaymentStatus(java.lang.Boolean autoPayment)
This method is a convenience method for setting the "isAutoPayment" property.
|
void | setAvailablePaymentAddresses(java.lang.String paymentMethodId, Address[] addresses)
This method is a convenience method for setting an "availableBillingAddresses." property.
|
void | setAvailablePaymentAttributes(java.lang.String paymentMethodId, Payment payment)
This method is a convenience method for setting an "availablePaymentAttributes." property.
|
void | setAvailablePayments(java.lang.String[] paymentMethodIds)
This method is a convenience method for setting the "availablePayment." properties.
|
void | setAvailableTieCode(java.lang.String nextTieCode)
This method is a convenience method for setting next available tie code.
|
void | setBusinessChannel(BusinessChannel businessChannel)
This is a convenience method for assigning aBusinessChannel to this order.
|
void | setCheckLock(java.lang.Boolean boolCheckLock)
This method is a convenience method for setting the "checkLock" property.
|
void | setClosing(boolean closing)
This method is a convenience method for setting the "Closing" property.
|
void | setConfirmViaEmail(java.lang.String confirmViaEmail)
This method is a convenience method for setting the "confirmViaEmail" property.
|
void | setContainerId(java.lang.String id)
This method is a convenience method for setting the "containerId" property.
|
void | setCurrencyCode(java.lang.String currencyCode)
This method is a convenience method for setting the "currencyCode" property.
|
void | setCurrentChargeDiscountAmount(java.lang.String discountAmount)
This method is a convenience method for setting the "currentChargeDiscountAmount" property.
|
void | setCurrentChargeExtendedPrice(java.lang.String extendedPrice)
This method is a convenience method for setting the "currentChargeExtendedPrice" property.
|
void | setCurrentChargeShippingAmount(java.lang.String shippingAmount)
This method is a convenience method for setting the "currentChargeShippingAmount" property.
|
void | setCurrentChargeTaxAmount(java.lang.String taxAmount)
Deprecated.
This has been deprecated and alternate method is addCurrentTaxAmount
|
void | setCurrentChargeTotalAmount(java.lang.String totalAmount)
This method is a convenience method for setting the "currentChargeTotalAmount" property.
|
void | setCurrentTieCode(java.lang.String tieCode)
This method is a convenience method for setting the "currentTieCode" property.
|
void | setCustomersEmailAddress(java.lang.String customersEmailAddress)
This method is a convenience method for setting the "customersEmailAddress" property.
|
void | setDatePlaced(java.lang.String datePlaced)
This method is a convenience method for setting the "datePlaced" property.
|
void | setDateTimeLastModified(java.lang.String dateTimeLastModified)
This method is a convenience method for setting the "dateTimeLastModified" property.
|
void | setDiscountAmount(java.lang.String discountAmount)
This method is a convenience method for setting the "discountAmount" property.
|
void | setEditableStatus(java.lang.Boolean orderEditable)
This method is a convenience method for setting the "orderEditable" property.
|
void | setEditorId(java.lang.String editorId)
This method is a convenience method for setting the "editorId" property.
|
void | setEditorLogonId(java.lang.String editorId)
This method is a convenience method for setting the "editorLogonId" property.
|
void | setEditorMode(java.lang.String mode)
This method is a convenience method for setting the "orderMode" property.
|
void | setExpireDate(java.lang.String expireDate)
This method is a convenience method for setting the "ExpireDate" property.
|
void | setExtendedPrice(java.lang.String extendedPrice)
This method is a convenience method for setting the "extendedPrice" property.
|
void | setHistoryExisted(java.lang.Boolean ordHistoryExisted)
This method is a convenience method for setting the "isHistoryExisted" property.
|
void | setIsEmpty(java.lang.String isEmpty_)
This method is a convenience method to set PROP_IS_EMPTY, if order is empty or not.
|
void | setItems(Line[] items)
This method is a convenience method for setting the "item." properties.
|
void | setLock(java.lang.Boolean locked)
This method is a convenience method for setting the "isLocked" property.
|
void | setMiscellaneousCharges(MiscellaneousCharge[] miscellaneousCharges)
This method is a convenience method for setting the "miscellaneousCharge." properties.
|
void | setNewVersionGenerated(java.lang.String newVersion)
This method sets the new order version.
|
void | setNotifyCustomer(java.lang.String toNotify)
This method is a convenience method for setting the PROP_NOTIFY_CUSTOMER property.
|
void | setOrderBlocks(OrderBlock[] blocks)
This is a convenience method for assigning an array of OrderBlocks to this order.
|
void | setOrderChanges(java.util.ArrayList orderChangesList) |
void | setOrderComment(java.lang.String comment)
This method is a convenience method for setting the "orderComment" property.
|
void | setOrderingCustomer(Customer orderingCustomer)
This method is a convenience method for setting the "orderingCustomer" property.
|
void | setOrderUnpaidBalance(java.lang.String unpaidBalance)
This method is a convenience method for setting the "orderUnpaidBalance" property.
|
void | setOrderVersion(java.lang.String orderVersion) |
void | setOrganization(Organization organization)
This method is a convenience method for setting the "organization" property.
|
void | setPayingCustomer(Customer payingCustomer)
This method is a convenience method for setting the "payingCustomer" property.
|
void | setPayments(Payment[] payments)
This method is a convenience method for setting the "payment." properties.
|
void | setPerformPaymentRefund(java.lang.String performPaymentRefund)
This method is a convenience method for setting the "performPaymentRefund" property.
|
void | setPONumber(java.lang.String ponumber)
This method is a convenience method for setting the "PONumber" property.
|
void | setPONumberRequired(boolean poNumberRequired)
This method is a convenience method for setting the "PONumberRequired" property.
|
void | setPrepared(boolean prepared)
This method is a convenience method for setting the "isPrepared" property.
|
void | setQuoteExpiryPeriod(java.lang.String maxExpiryTime)
This method is a convenience method for setting the "MaxQuoteExpiryPeriod" property.
|
void | setRequirePreparation(boolean requirePreparation)
This method is a convenience method for setting the "requirePreparation" property.
|
void | setSalesContainerComment(ModelObjectList comment)
This method is a convenience method for setting the current setting of the PROP_COMMENTS property.
|
void | setShipAsComplete(java.lang.String shipAsComplete)
This method is a convenience method for setting the "shipAsComplete" property.
|
void | setShippingInfo(ShippingInfo info)
This method is a convenience method for setting the "shippingInformation" property.
|
void | setShipToCustomers(Customer[] customers)
This method is a convenience method for setting the "shipToCustomers" property.
|
void | setStatus(java.lang.String status)
This method is a convenience method for setting the "status" property.
|
void | setStatusLabel(java.lang.String statusCode)
Sets a displayable string representation of the status code.
|
void | setStoreDescription(java.lang.String storeDescription)
This method is a convenience method for setting the "storeDescription" property.
|
void | setStoreId(java.lang.String storeId)
This method is a convenience method for setting the "storeId" property.
|
void | setTakeOverOrder(java.lang.Boolean takeOver)
This method is a convenience method for setting the "takeOverOrder" property.
|
void | setTotalAmount(java.lang.String totalAmount)
This method is a convenience method for setting the "totalAmount" property.
|
void | setTransportationCharge(java.lang.String transportationCharge)
This method is a convenience method for setting the "transportationCharge" property.
|
boolean | takeOverOrder()
This method is a convenience method for retrieving the current setting of the "takeOverOrder" property.
|
java.lang.String | toString()
Returns a string representation of this sales container.
|
void | updateItem(Line item)
This method is a convenience method for updating an "item." property.
|
void | updatePayment(Payment payment)
This method is a convenience method for updating an "payment." property.
|
public static final java.lang.String STATUS_ORDER_PENDING
public static final java.lang.String STATUS_ORDER_CANCELED
public static final java.lang.String STATUS_ORDER_COMPLETED
public static final java.lang.String STATUS_ORDER_SUBMITTED
public static final java.lang.String STATUS_ORDER_AUTH_ALLOWED
public static final java.lang.String STATUS_ORDER_INV_UPDATE_FAILED
public static final java.lang.String STATUS_ORDER_BACKORDERED
public static final java.lang.String STATUS_ORDER_PAYMENT_AUTH_REVIEW
public static final java.lang.String STATUS_ORDER_RELEASED
public static final java.lang.String STATUS_ORDER_SHIPPED
public static final java.lang.String STATUS_ORDER_DEPOSITED
public static final java.lang.String STATUS_ORDER_READY_FOR_REMOTE_FULFILLMENT
public static final java.lang.String STATUS_ORDER_PENDING_REMOTE_FULFILLMENT
public static final java.lang.String STATUS_ORDER_REMOTE_FULFILLMENT_FAILED
public static final java.lang.String STATUS_ORDER_DENIED
public static final java.lang.String STATUS_ORDER_EDITED
public static final java.lang.String STATUS_ORDER_WAITING_APPROVAL
public static final java.lang.String STATUS_REQUISITION_LIST_PRIVATE
public static final java.lang.String STATUS_REQUISITION_LIST_SHAREABLE
public static final java.lang.String STATUS_ORDER_PROFILE
public static final java.lang.String STATUS_TEMPORARY
public static final java.lang.String STATUS_QUOTE_NEW
public static final java.lang.String STATUS_QUOTE_READY
public static final java.lang.String STATUS_QUOTE_CANCELED
public static final java.lang.String STATUS_NONE
public static final java.lang.String STATUS_READ
public static final java.lang.String PROP_TYPE
The value is "type".
The data stored under the "type" property is a String that represents the actual type of this object. The value can be "ORDER" or "QUOTE".
public static final java.lang.String TYPE_ORDER
public static final java.lang.String TYPE_QUOTE
public static final java.lang.String PROP_IS_EMPTY
public static final java.lang.String PROP_AVAILABLE_PAYMENT
The value is "availablePayment.".
The data stored under property names with the "availablePayment." prefix is of type String. The full property name is "availablePayment.paymentMethodId", where paymentMethodId is the payment type's unique identifier.
public static final java.lang.String PROP_AVAILABLE_PAYMENT_ATTRIBUTES
The value is "availablePayment Attributes.".
The data stored under property names with the "availablePaymentAttributes." prefix is of type String. The full property name is "availablePaymentAttributes.name="key">value", where key where key is the attribute Name, and value is Attribute Value.
public static final java.lang.String PROP_AVAILABLE_BILLING_ADDRESSES
The value is "availableBillingAddresses.".
The data stored under property names with the "availableBillingAddresses." prefix is of type String. The full property name is "availableBillingAddresses.paymentMethodId", where paymentMethodId is the payment method's unique identifier.
public static final java.lang.String PROP_MISCELLANEOUS_CHARGE
The value is "miscellaneousCharge.".
The data stored under property names with the "miscellaneousCharge." prefix is of type MiscellaneousCharge. The full property name is "miscellaneousCharge.miscellaneousChargeId", where miscellaneousChargeId is the miscellaneous charge type's unique identifier.
public static final java.lang.String PROP_SHIPPING_INFO
The value is "shippingInformation".
The data stored under the "shippingInformation" property is a OrderShippingInfo that represents the order's shipping information.
public static final java.lang.String PROP_CURRENT_CHARGE_DISCOUNT_AMOUNT
The value is "currentChargeDiscountAmount".
The data stored under the "currentChargeDiscountAmount" property is a String that represents the order's current charge total amount.
public static final java.lang.String PROP_CURRENT_CHARGE_EXTENDED_PRICE
The value is "currentChargeExtendedPrice".
The data stored under the "currentChargeExtendedPrice" property is a String that represents the order's current charge extended price.
public static final java.lang.String PROP_CURRENT_CHARGE_SHIPPING_AMOUNT
The value is "currentChargeShippingAmount".
The data stored under the "currentChargeShippingAmount" property is a String that represents the order's current charge shipping amount.
public static final java.lang.String PROP_CURRENT_CHARGE_TAX_AMOUNT
The value is "currentChargeTaxAmount".
The data stored under the "currentChargeTaxAmount" property is a String that represents the order's current charge tax amount.
public static final java.lang.String PROP_CURRENT_CHARGE_TOTAL_AMOUNT
The value is "currentChargeTotalAmount".
The data stored under the "currentChargeTotalAmount" property is a String that represents the order's current charge total amount.
public static final java.lang.String PROP_CURRENCY_CODE
The value is "currencyCode".
The data stored under the "currencyCode" property is a String that contains the order's currency code.
public static final java.lang.String PROP_DATE_PLACED
The value is "datePlaced".
The data stored under the "datePlaced" property is a String that represents the date that this order was placed.
public static final java.lang.String PROP_DATE_TIME_LAST_MODIFIED
The value is "dateTimeLastModified".
The data stored under the "dateTimeLastModified" property is a String that represents the date/time that this order was last modified.
public static final java.lang.String PROP_DISCOUNT_AMOUNT
The value is "discountAmount".
The data stored under the "discountAmount" property is a String that represents the order's total amount.
public static final java.lang.String PROP_EDITOR_ID
The value is "editorId".
The data stored under the "editorId" property is a String that represents the order's editor Id while in EDT state.
public static final java.lang.String PROP_EDITOR_LOGON_ID
The value is "editorLogonId".
The data stored under the "editorLogonId" property is a String that represents the order's editor logon ID while in EDT state.
public static final java.lang.String PROP_EXTENDED_PRICE
The value is "extendedPrice".
The data stored under the "extendedPrice" property is a String that represents the order's extended price.
public static final java.lang.String PROP_IS_PREPARED
The value is "isPrepared".
The data stored under the "isPrepared" property is a Boolean that represents the order's prepared status. This property will work with PROP_REQUIRE_PREPARATION to determine when the PrepareOrder request will be launched.
public static final java.lang.String PROP_REQUIRE_PREPARATION
The value is "requirePreparation".
The data stored under the "requirePrepare" property is a Boolean that indicates whether the order is required order preparation or not. This property will work with PROP_IS_PREPARED to determine when the PrepareOrder request will be launched. The property will be set true when updating tiecode and shipAsComplete.
public static final java.lang.String PROP_ITEM
The value is "item.".
The data stored under property names with the "item." prefix is of type Line. The full property name is "item.lineNumber", where lineNumber is the line item line number.
public static final java.lang.String PROP_ADDED_ITEMS
The value is "addedItems".
public static final java.lang.String PROP_DELETED_ITEMS
The value is "deletedItems".
public static final java.lang.String PROP_CONTAINER_ID
The value is "containerId".
The data stored under the "containerId" property is a String that contains the order's primary id.
public static final java.lang.String PROP_STATUS
The value is "status".
The data stored under the "status" property is a String that represents the status of this order.
public static final java.lang.String PROP_STATUS_LABEL
The value is "statusLabel".
The data stored under the "statusLabel" property is a String that represents the displayable status of this order.
public static final java.lang.String PROP_ORDER_BLOCKS
The value is "orderBlocks".
The data stored under the "orderBlocks" property is an array of OrderBlock objects that represent all of the blocks associated with this order.
public static final java.lang.String PROP_ORDERING_CUSTOMER
The value is "orderingCustomer".
The data stored under the "orderingCustomer" property is a Customer that represents the customer that is making this order.
public static final java.lang.String PROP_PAYING_CUSTOMER
The value is "payingCustomer".
The data stored under the "payingCustomer" property is a Customer that represents the customer that is paying for this order.
public static final java.lang.String PROP_PAYMENT
The value is "payment.".
The data stored under property names with the "payment." prefix is of type Payment. The full property name is "payment.paymentNumber", where paymentNumber is the payment's unique identifier number.
public static final java.lang.String PROP_SHIP_TO_CUSTOMERS
The value is "shipToCustomers".
The data stored under the "shipToCustomers" property is a ModelObjectList that contains a list of Customer objects that represent the customers that this order will be shipped to.
public static final java.lang.String PROP_TAX
The value is "tax.".
The data stored under property names with the "tax." prefix is of type String. The full property name is "tax.charge", where charge is the name of the tax.
public static final java.lang.String PROP_CURRENT_TAX
The value is "currentTax.".
The data stored under property names with the "currentTax." prefix is of type String. The full property name is "currentTax.charge", where charge is the name of the current tax.
public static final java.lang.String PROP_TOTAL_AMOUNT
The value is "totalAmount".
The data stored under the "totalAmount" property is a String that represents the order's total amount.
public static final java.lang.String PROP_TRANSPORTATION_CHARGE
The value is "transportationCharge".
The data stored under the "transportationCharge" property is a String that represents the order's transportation charge.
public static final java.lang.String PROP_UNIQUE_ID
The value is "uniqueId".
The data stored under the "uniqueId" property is a generated Integer that is unique to this object. This property is considered a significant property until a valid "containerId" property is set.
public static final java.lang.String PROP_CONFIRM_VIA_EMAIL
The value is "confirmViaEmail".
The data stored under the "confirmViaEmail" property is a String that represents whether confirmViaEmail is Y or N.
public static final java.lang.String PROP_CURRENT_TIE_CODE
The value is "currentTieCode".
The data stored under the "currentTieCode" property is a String that contains current tie code displayed for the order.
public static final java.lang.String PROP_SHIP_AS_COMPLETE
The value is "shipAsComplete".
The data stored under the "shipAsComplete" property is a String that represents whether shipAsComplete is Y or N.
public static final java.lang.String PROP_BUSINESS_CHANNEL
The value is "businessChannel".
The data stored under the "businessChannel" property is a BusinessChannel object that represents the business channel associated with this order.
public static final java.lang.String PROP_SHIP_MODES
The value is "shipmodes".
The data stored under the "shipmodes" property is a ModelObjectList This property stores a list of shipping modes
public static final java.lang.String PROP_ORDER_UNPAID_BALANCE
The value is "orderUnpaidBalance".
The data stored under the "orderUnpaidBalance" property is a String that represents the order's remaining amount to allocate payments for.
public static final java.lang.String PROP_CACHED_PRODUCTS
The value is "cachedProducts".
The data stored under the "cachedProducts" property is a java.util.Hashtable that contains cached Product objects.
public static final java.lang.String PROP_CACHED_ADDRESSES
The value is "cachedAddresses".
The data stored under the "cachedAddresses" property is a java.util.Hashtable that contains cached Address objects.
public static final java.lang.String PROP_QUOTE_EXPIRY_PERIOD
The value is "QuoteExpiryPeriod".
The data stored under the "QuoteExpiryPeriod" property is a String that represents value of maximum number of days the quote is valid for
public static final java.lang.String PROP_EXPIRE_DATE
The value is "ExpireDate".
The data stored under the "ExpireDate" property is a String that represents value of expire date of the quote
public static final java.lang.String PROP_CLOSING
The value is "Closing".
The data stored under the "Closing" property is a Boolean that indicates that the order is being closed.
public static final java.lang.String PROP_ITEMS
The value is "items".
The data stored under the "items" property is the ModelObjectList that indicates represents the line items in this sales container.
public static final java.lang.String PROP_ORDER_VERSION
The value is "orderVersion".
The data stored under the "orderVersion" property is a String object.
public static final java.lang.String PROP_NEW_VERSION_GENERATED
The value is "newVersionGenerated".
The data stored under the "newVersionGenerated" property is a String object.
public static final java.lang.String PROP_ORDERCHANGE_INFORMATION_LIST
The value is "orderChanges".
The data stored under the "orderChanges" property is an ArrayList that contains the List of OrderHistoryInformation objects.
public static final java.lang.String PROP_ORDER_VERSIONS
The value is "orderVersions".
The data stored under the "orderVersions" property is a ModelObjectList that contains the List of OrderVersion objects.
public static final java.lang.String PROP_ORDERCHANGE_REASONS_LIST
The value is "orderChangeReasons".
The data stored under the "orderChangeReasons" property is an ArrayList that contains the List of OrderChangeReason objects.
public static final java.lang.String PROP_COMMENTS
The value is "salesContainerComment".
The data stored under the "salesContainerComment" property is an ModelObjectList that contains a list of SalesContainerComment objects.
public static final java.lang.String PROP_PAYMENTS
The value is "payments".
The data stored under the "payments" property is the ModelObjectList that indicates represents the line items in this sales container.
public static final java.lang.String PROP_STORE_ID
The value is "storeId".
The data stored under the "storeId" property is a String that contains the primary ID of the store associated with this sales container.
public static final java.lang.String PROP_STORE_DESCRIPTION
The value is "storeDescription".
The data stored under the "storeDescription" property is a String that contains the description of the store associated with this sales container.
public static final java.lang.String PROP_PO_NUMBER_REQUIRED
The value is "PONumberRequired".
The data stored under the "PONumberRequired" property is a Boolean that indicates if the purchase order number is required for this order.
public static final java.lang.String PROP_PO_NUMBER
The value is "PONumber".
The data stored under the "PONumber" property is a String that contains the purchase order number for this order.
public static final java.lang.String PROP_ORDER_EDITABLE_STATUS
The value is "isOrderEditable".
The data stored under the "orderEditable" property is a boolean that contains if the order can be edited or not.
public static final java.lang.String PROP_ORDER_PENDING_APPROVAL_STATUS
The value is "orderApprovalPending".
The data stored under the "orderApprovalPending" property is a boolean that contains if the order requires approval or not. true if approval is pending false otherwise.
public static final java.lang.String PROP_ORDER_COMMENT
The value is "orderComment".
The data stored under the "orderComment" property is a String that contains the comment that why Order has been canceled.
public static final java.lang.String PROP_NOTIFY_CUSTOMER
The value is "sendEmailNotification".
The data stored under the "sendEmailNotification" property is a String that contains whether customer needs to notify by E-mail or not.
public static final java.lang.String PROP_PERFORM_PAYMENT_REFUND
The value is "paymentRefundForce".
The data stored under the "performPaymentRefund" property is a String that is perform payment refund while canceling order if any payment is deposited.
public static final java.lang.String PROP_CUSTOMERS_EMAIL_ADDRESS
The value is "customersEmailAddress".
The data stored under the "customersEmailAddress" property is a String that is customer's e-mail address to notify customer via e-mail.
public static final java.lang.String PROP_IS_AUTO_PAYMENT
The value is "isAutoPayment".
The data stored under the "isAutoPayment" property is a Boolean that represents if the payment must be added when order/quote is submitted with underpayments.
public static final java.lang.String PROP_TAKE_OVER_ORDER
The value is "takeOverOrder".
The data stored under the "takeOverLock" property is a Boolean that represents if the order edit is taken over by the current CSR from another CSR. This property is valid only for Orders.
public static final java.lang.String PROP_ORDER_LOCKED
The value is "isLocked".
The data stored under the "isLocked" property is a Boolean that represents if the order is locked or not. This property is valid only for Orders.
public static final java.lang.String PROP_ORDER_HISTORY_EXISTED
The value is "isHistoryExisted".
The data stored under the "isHistoryExisted" property is a Boolean that represents if the order has history or not.
public static final java.lang.String PROP_PROMOTION_CODE_APPLICABLE
The value is "isPromotionCodeApplicable".
The data stored under the "isPromotionCodeApplicable" property is a Boolean that represents if the promotion code is applicable or not.
public static final java.lang.String PROP_AVILABLE_NEXT_TIE_CODE
The value is "avilableTieCode".
The data stored under the "avilableTieCode" property is a String that represents the available next tie code.
public static final java.lang.String PROP_CHECK_ORDER_LOCK
The value is "checkLock".
The data stored under the "checkLock" property is a Boolean that represents if the current user has locked the current order. This property is valid only for Orders.
public static final java.lang.String PROP_ORGANIZATION
The value is "organization".
The data stored under the "organization" property is a Organization that represents the organization associated with the order or quote.
public static final java.lang.String PROP_ORDER_MODE
The value is "orderMode".
The data stored under the "orderMode" property is a String that represents the mode of the order editor. The value can be "CREATE_MODE" or "EDIT_MODE". This property is valid only for Orders.
public static final java.lang.String CREATE_MODE
The value is "createMode".
public static final java.lang.String EDIT_MODE
The value is "editMode".
public static final java.lang.String PROP_APPLIED_ORDER_PROMOTION_CODES
public final java.lang.String pickupInStoreValue
public final java.lang.String PROP_IS_PICKUP_IN_STORE
public void addAvailablePayment(java.lang.String paymentMethodId)
public void addItem(Line item)
public void addPayment(Payment payment)
public void addMiscellaneousCharge(MiscellaneousCharge miscellaneousCharge)
public void removeMiscellaneousCharges()
public void addTaxAmount(java.lang.String charge, java.lang.String taxAmount)
public void addCurrentTaxAmount(java.lang.String charge, java.lang.String taxAmount)
public java.lang.String getType()
public java.lang.String[] getAvailablePayments()
public java.lang.String getCurrentChargeDiscountAmount()
public java.lang.String getCurrentChargeExtendedPrice()
public java.lang.String getCurrentChargeShippingAmount()
public java.lang.String getCurrentChargeTotalAmount()
public java.lang.String getCurrencyCode()
public java.lang.String getDateTimeLastModified()
public java.lang.String getDatePlaced()
public java.lang.String getDiscountAmount()
public java.lang.String getEditorId()
public java.lang.String getEditorLogonId()
public java.lang.String getExtendedPrice()
public Line getItem(java.lang.String lineNumber)
public Line[] getItems()
public ModelObjectList getItemsModelObjectList()
protected int compareDates(java.lang.Object e1, java.lang.Object e2)
public MiscellaneousCharge[] getMiscellaneousCharges()
public java.lang.String getContainerId()
public OrderBlock[] getCopyOfOrderBlocks()
public int getNumberOfActiveBlocks()
The order is considered as "blocked" if there is at least 1 OrderBlock object for this order that is "active".
public OrderBlock[] getOrderBlocks()
public Customer getOrderingCustomer()
public java.lang.String getOrderUnpaidBalance()
public java.lang.String getStatus()
public Customer getPayingCustomer()
public Payment getPayment(java.lang.String paymentNumber)
public Payment[] getPayments()
public ModelObjectList getPaymentsModelObjectList()
public Customer[] getShipToCustomers()
public ModelObjectList getShipToCustomersModelObjectList()
public java.lang.String getTaxAmount()
public java.lang.String getCurrentChargeTaxAmount()
public java.lang.String getTaxAmount(java.lang.String charge)
public java.lang.String getCurrentTaxAmount(java.lang.String charge)
public Line[] getTiedItems(java.lang.String tieCode)
public java.lang.String getTotalAmount()
public java.lang.String getTransportationCharge()
public java.util.List getOrderChanges()
public java.lang.String getOrderVersion()
public java.lang.String getNewVersionGenerated()
public ModelObjectList getOrderVersions()
public java.util.List getOrderChangeReasons()
public void setOrderChanges(java.util.ArrayList orderChangesList)
public void setOrderVersion(java.lang.String orderVersion)
public void setNewVersionGenerated(java.lang.String newVersion)
public void addOrderChangeInfo(OrderHistoryInformation orderChangeInfo)
public void addOrderVersionObject(OrderVersion orderVersion)
public ShippingInfo getShippingInfo()
public boolean isBlocked()
The order is considered as "blocked" if there is at least 1 OrderBlock object for this order that is "active".
public boolean isEditEnabled()
public boolean isPrepared()
public boolean isRequirePreparation()
public void reset()
public void setAvailablePayments(java.lang.String[] paymentMethodIds)
public void setCurrentChargeDiscountAmount(java.lang.String discountAmount)
public void setCurrentChargeExtendedPrice(java.lang.String extendedPrice)
public void setCurrentChargeShippingAmount(java.lang.String shippingAmount)
public void setCurrentChargeTaxAmount(java.lang.String taxAmount)
public void setCurrentChargeTotalAmount(java.lang.String totalAmount)
public void setCurrencyCode(java.lang.String currencyCode)
public void setShippingInfo(ShippingInfo info)
public void setDatePlaced(java.lang.String datePlaced)
public void setDateTimeLastModified(java.lang.String dateTimeLastModified)
public void setDiscountAmount(java.lang.String discountAmount)
public void setEditorId(java.lang.String editorId)
public void setEditorLogonId(java.lang.String editorId)
public void setExtendedPrice(java.lang.String extendedPrice)
public void setItems(Line[] items)
public void setMiscellaneousCharges(MiscellaneousCharge[] miscellaneousCharges)
public void setContainerId(java.lang.String id)
public void setOrderBlocks(OrderBlock[] blocks)
public void setOrderingCustomer(Customer orderingCustomer)
public void setOrderUnpaidBalance(java.lang.String unpaidBalance)
public void setStatus(java.lang.String status)
The setStatusLabel method is called when the status code is set.
public void setPayingCustomer(Customer payingCustomer)
public void setPayments(Payment[] payments)
public void setPrepared(boolean prepared)
public void setRequirePreparation(boolean requirePreparation)
public void setShipToCustomers(Customer[] customers)
public void setTotalAmount(java.lang.String totalAmount)
public void setTransportationCharge(java.lang.String transportationCharge)
public java.lang.String toString()
public void updateItem(Line item)
public void updatePayment(Payment payment)
public Address[] getAvailablePaymentAddresses(java.lang.String paymentMethodId)
public void setAvailablePaymentAddresses(java.lang.String paymentMethodId, Address[] addresses)
public Payment getAvailablePaymentAttributes(java.lang.String paymentMethodId)
public void setAvailablePaymentAttributes(java.lang.String paymentMethodId, Payment payment)
public java.lang.String getAvailableTieCode()
public BusinessChannel getBusinessChannel()
public boolean getConfirmViaEmail()
public java.lang.String getCurrentTieCode()
public boolean hasTieCode()
public boolean isShipAsComplete()
public boolean isPickupInStoreShippingMode()
public boolean hasNonEditableItems()
Note: An order item usually becomes non-editable if after submitting the Order, the RTF (Release to fulfillment) was run against the order on the server. That is the order item can no longer be modified even if the Order is brought from PRC to EDT state.
public boolean hasActiveOperatorEditorId()
public void setBusinessChannel(BusinessChannel businessChannel)
public void setCurrentTieCode(java.lang.String tieCode)
public void setConfirmViaEmail(java.lang.String confirmViaEmail)
public void setShipAsComplete(java.lang.String shipAsComplete)
protected void fireModelObjectChangedEvent(java.lang.String propertyName, java.lang.Object oldData, java.lang.Object newData)
public void addShipMode(ShippingMode shippingMode)
public ShippingMode[] getShipModes()
public ShippingMode getShipMode(java.lang.String shippingModeId)
public java.util.Hashtable getCachedProducts()
public void addCachedProduct(Product product)
public Product findCachedProduct(java.lang.String catalogEntryId)
public void clearProductCache()
public java.util.Hashtable getCachedAddresses()
public void addCachedAddress(Address address)
public Address findCachedAddress(java.lang.String addressId)
public void clearAddressCache()
public java.lang.String getQuoteExpiryPeriod()
public void setQuoteExpiryPeriod(java.lang.String maxExpiryTime)
public java.lang.String getExpireDate()
public void setExpireDate(java.lang.String expireDate)
public boolean getClosing()
public void setClosing(boolean closing)
public ModelObjectList getSalesContainerComment()
public void setSalesContainerComment(ModelObjectList comment)
public void addComment(SalesContainerComment comment)
public SalesContainerComment[] getComments()
public java.lang.String getStoreId()
public java.lang.String getStoreDescription()
public void setStoreId(java.lang.String storeId)
public void setStoreDescription(java.lang.String storeDescription)
public void setPONumberRequired(boolean poNumberRequired)
public boolean isPONumberRequired()
public void setPONumber(java.lang.String ponumber)
public java.lang.String getPONumber()
public boolean isEditable()
public void setEditableStatus(java.lang.Boolean orderEditable)
public boolean isApprovalPending()
public void setApprovalPendingStatus(java.lang.Boolean orderApprovalPending)
public void setOrderComment(java.lang.String comment)
public void setNotifyCustomer(java.lang.String toNotify)
public void setPerformPaymentRefund(java.lang.String performPaymentRefund)
public java.lang.String getOrderComment()
public java.lang.String getNotifyCustomer()
public java.lang.String getPerformPaymentRefund()
public java.lang.String getCustomersEmailAddress()
public void setCustomersEmailAddress(java.lang.String customersEmailAddress)
public void setStatusLabel(java.lang.String statusCode)
This method should be over written by the subclass (example: Order, Quote).
public java.lang.String getStatusLabel()
public boolean takeOverOrder()
public void setTakeOverOrder(java.lang.Boolean takeOver)
public boolean isLocked()
public boolean isHistoryExisted()
public void setLock(java.lang.Boolean locked)
public void setHistoryExisted(java.lang.Boolean ordHistoryExisted)
public boolean checkLock()
public void setCheckLock(java.lang.Boolean boolCheckLock)
public java.lang.String getEditorMode()
public void setEditorMode(java.lang.String mode)
public boolean isAutoPayment()
public void setAutoPaymentStatus(java.lang.Boolean autoPayment)
public boolean canAddPayment()
public void refresh(ModelObject refreshSource)
public boolean isPromotionCodeApplicable()
public ModelObjectList getAppliedOrderPromotionCodes()
public void setAppliedOrderPromotionCodes(ModelObjectList promotionCodes)
public void clearComments()
public void clearOrderVersions()
public boolean isEmpty()
public void setIsEmpty(java.lang.String isEmpty_)
public void setAvailableTieCode(java.lang.String nextTieCode)
public void setOrganization(Organization organization)
public Organization getOrganization()