Basis for item-based objects stemming from a single Order, with these common properties (Invoice is used as an example):
- The object has been created from an Order accessible using getOrder()
- Contains a collection of items, each item related to exactly one OrderItemwhich in turn represents an extension to one of the order ProductLineItemor one ShippingLineItem. Example: an Invoicehas InvoiceItems
- The items hold various prices which are summed, resulting in a product-subtotal, a service-subtotaland a grand-total, each represented by a SumItem.
- The object is customizable using custom properties
All Known Subclasses
Appeasement, Invoice, Return, ReturnCase, ShippingOrder
Property Summary
| Property | Description |
|---|---|
createdBy: String (read-only) |
Created by this user. |
creationDate: Date (read-only) |
The time of creation. |
grandTotal: SumItem (read-only) |
Returns the sum-item representing the grandtotal for all items. |
items: FilteringCollection (read-only) |
Returns the unsorted collection of items |
lastModified: Date (read-only) |
The last modification time. |
modifiedBy: String (read-only) |
Last modified by this user. |
order: Order (read-only) |
Returns the Order this object was created for. |
productSubtotal: SumItem (read-only) |
Returns the sum-item representing the subtotal for product items. |
serviceSubtotal: SumItem (read-only) |
Returns the sum-item representing the subtotal for service items such as shipping. |
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
| Method | Description |
|---|---|
| getCreatedBy() | Created by this user. |
| getCreationDate() | The time of creation. |
| getGrandTotal() | Returns the sum-item representing the grandtotal for all items. |
| getItems() | Returns the unsorted collection of items |
| getLastModified() | The last modification time. |
| getModifiedBy() | Last modified by this user. |
| getOrder() | Returns the Order this object was created for. |
| getProductSubtotal() | Returns the sum-item representing the subtotal for product items. |
| getServiceSubtotal() | Returns the sum-item representing the subtotal for service items such as shipping. |
Methods inherited from class Extensible
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Property Details
createdBy
- createdBy: String
(read-only)- : Created by this user.
creationDate
- creationDate: Date
(read-only)- : The time of creation.
grandTotal
- grandTotal: SumItem
(read-only)- : Returns the sum-item representing the grandtotal for all items.
items
- items: FilteringCollection
(read-only)- : Returns the unsorted collection of items
lastModified
- lastModified: Date
(read-only)- : The last modification time.
modifiedBy
- modifiedBy: String
(read-only)- : Last modified by this user.
order
productSubtotal
- productSubtotal: SumItem
(read-only)- : Returns the sum-item representing the subtotal for product items.
serviceSubtotal
- serviceSubtotal: SumItem
(read-only)- : Returns the sum-item representing the subtotal for service items such as shipping.
Method Details
getCreatedBy()
- getCreatedBy(): String
-
: Created by this user.
Returns:
- Created by this user
-
getCreationDate()
- getCreationDate(): Date
-
: The time of creation.
Returns:
- time of creation.
-
getGrandTotal()
- getGrandTotal(): SumItem
-
: Returns the sum-item representing the grandtotal for all items.
Returns:
- sum-item for all items
-
getItems()
- getItems(): FilteringCollection
-
: Returns the unsorted collection of items
Returns:
- the unsorted collection of items
-
getLastModified()
- getLastModified(): Date
-
: The last modification time.
Returns:
- last modification time..
-
getModifiedBy()
- getModifiedBy(): String
-
: Last modified by this user.
Returns:
- Last modified by this user
-
getOrder()
- getOrder(): Order
-
: Returns the Order this object was created for.
Returns:
- the Order this object was created for.
-
getProductSubtotal()
- getProductSubtotal(): SumItem
-
: Returns the sum-item representing the subtotal for product items.
Returns:
- sum-item for product items
-
getServiceSubtotal()
- getServiceSubtotal(): SumItem
-
: Returns the sum-item representing the subtotal for service items such as shipping.
Returns:
- sum-item for service items such as shipping
-
<!-- prettier-ignore-end -->