Interface | osid.ordering.Order | ||
---|---|---|---|
Implements | osid.OsidObject | ||
osid.Aggregateable | |||
Description |
An | ||
Method | getCustomerId | ||
Description |
Gets the | ||
Return | osid.id.Id | the customer Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getCustomer | ||
Description |
Gets the customer. | ||
Return | osid.resource.Resource | the customer | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemIds | ||
Description |
Gets the | ||
Return | osid.id.IdList | the item Ids | |
Compliance | mandatory | This method must be implemented. | |
Method | getItems | ||
Description |
Gets the items. | ||
Return | osid.ordering.ItemList | the items | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getTotalCost | ||
Description |
Gets the total cost for this order. | ||
Return | osid.financials.Currency | the total cost | |
Compliance | mandatory | This method must be implemented. | |
Method | isAtomic | ||
Description |
Tests if all the items are processed atomically. | ||
Return | boolean | true if the order is atomic, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | isSubmitted | ||
Description |
Tests if all this order has been submitted. | ||
Return | boolean | true if the order has been submitted, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubmitDate | ||
Description |
Gets the date submitted. | ||
Return | osid.calendaring.DateTime | the date submitted | |
Errors | ILLEGAL_STATE | isSubmitted() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubmitterId | ||
Description |
Gets the resource | ||
Return | osid.id.Id | the submitting resource Id | |
Errors | ILLEGAL_STATE | isSubmitted() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubmitter | ||
Description |
Gets the agent who submitted the order. | ||
Return | osid.resource.Resource | the submitting resource | |
Errors | ILLEGAL_STATE | isSubmitted() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubmittingAgentId | ||
Description |
Gets the agent | ||
Return | osid.id.Id | the submitting agent Id | |
Errors | ILLEGAL_STATE | isSubmitted() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubmittingAgent | ||
Description |
Gets the agent who submitted the order. | ||
Return | osid.authentication.Agent | the submitting agent | |
Errors | ILLEGAL_STATE | isSubmitted() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | isClosed | ||
Description |
Tests if all this order is closed or canceled. | ||
Return | boolean | true if the order is closed, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getClosedDate | ||
Description |
Gets the date this order has been closed. | ||
Return | osid.calendaring.DateTime | the date closed | |
Errors | ILLEGAL_STATE | isClosed() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getCloserId | ||
Description |
Gets the resource | ||
Return | osid.id.Id | the closing resource Id | |
Errors | ILLEGAL_STATE | isClosed() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getCloser | ||
Description |
Gets the resource who closed the order. | ||
Return | osid.resource.Resource | the closing resource | |
Errors | ILLEGAL_STATE | isClosed() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getClosingAgentId | ||
Description |
Gets the agent | ||
Return | osid.id.Id | the closing agent Id | |
Errors | ILLEGAL_STATE | isClosed() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getClosingAgent | ||
Description |
Gets the agent who closed the order. | ||
Return | osid.authentication.Agent | the closing agent | |
Errors | ILLEGAL_STATE | isClosed() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrderRecord | ||
Description |
Gets the order record corresponding to the given | ||
Parameters | osid.type.Type | orderRecordType | the type of order record to retrieve |
Return | osid.ordering.records.OrderRecord | the order record | |
Errors | NULL_ARGUMENT | orderRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(orderRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |