public interface Order extends OsidObject, Aggregateable
An Order.
Modifier and Type | Method and Description |
---|---|
DateTime |
getClosedDate()
Gets the date this order has been closed.
|
Resource |
getCloser()
Gets the resource who closed the order.
|
Id |
getCloserId()
Gets the resource
Id who closed the order. |
Agent |
getClosingAgent()
Gets the agent who closed the order.
|
Id |
getClosingAgentId()
Gets the agent
Id who closed the order. |
Resource |
getCustomer()
Gets the customer.
|
Id |
getCustomerId()
Gets the
Id of the customer. |
IdList |
getItemIds()
Gets the
Ids of the items. |
ItemList |
getItems()
Gets the items.
|
OrderRecord |
getOrderRecord(Type orderRecordType)
Gets the order record corresponding to the given
Order
record Type. |
DateTime |
getSubmitDate()
Gets the date submitted.
|
Resource |
getSubmitter()
Gets the agent who submitted the order.
|
Id |
getSubmitterId()
Gets the resource
Id who submitted the order. |
Agent |
getSubmittingAgent()
Gets the agent who submitted the order.
|
Id |
getSubmittingAgentId()
Gets the agent
Id who submitted the order. |
Currency |
getTotalCost()
Gets the total cost for this order.
|
boolean |
isAtomic()
Tests if all the items are processed atomically.
|
boolean |
isClosed()
Tests if all this order is closed or canceled.
|
boolean |
isSubmitted()
Tests if all this order has been submitted.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getCustomerId()
Id
of the customer. Id
mandatory
- This method must be implemented. Resource getCustomer() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getItemIds()
Ids
of the items. Ids
mandatory
- This method must be implemented. ItemList getItems() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Currency getTotalCost()
mandatory
- This method must be implemented. boolean isAtomic()
true
if the order is atomic, false
otherwisemandatory
- This method must be implemented. boolean isSubmitted()
true
if the order has been submitted,
false
otherwisemandatory
- This method must be implemented. DateTime getSubmitDate()
IllegalStateException
- isSubmitted()
is
false
mandatory
- This method must be implemented. Id getSubmitterId()
Id
who submitted the order. Id
IllegalStateException
- isSubmitted()
is
false
mandatory
- This method must be implemented. Resource getSubmitter() throws OperationFailedException
IllegalStateException
- isSubmitted()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getSubmittingAgentId()
Id
who submitted the order. Id
IllegalStateException
- isSubmitted()
is
false
mandatory
- This method must be implemented. Agent getSubmittingAgent() throws OperationFailedException
IllegalStateException
- isSubmitted()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isClosed()
true
if the order is closed, false
otherwisemandatory
- This method must be implemented. DateTime getClosedDate()
IllegalStateException
- isClosed()
is
false
mandatory
- This method must be implemented. Id getCloserId()
Id
who closed the order. Id
IllegalStateException
- isClosed()
is
false
mandatory
- This method must be implemented. Resource getCloser() throws OperationFailedException
IllegalStateException
- isClosed()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getClosingAgentId()
Id
who closed the order. Id
IllegalStateException
- isClosed()
is
false
mandatory
- This method must be implemented. Agent getClosingAgent() throws OperationFailedException
IllegalStateException
- isClosed()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. OrderRecord getOrderRecord(Type orderRecordType) throws OperationFailedException
Order
record Type.
This method is used to retrieve an object
implementing the requested record. The orderRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a Type
hierarchy where
hasRecordType(orderRecordType)
is true
.orderRecordType
- the type of order record to retrieveNullArgumentException
- orderRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(orderRecordType)
is false
mandatory
- This method must be implemented.