OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.Order
Implementsosid.OsidObject
osid.Aggregateable
Description

An Order.

MethodgetCustomerId
Description

Gets the Id of the customer.

Returnosid.id.Idthe customer Id
CompliancemandatoryThis method must be implemented.
MethodgetCustomer
Description

Gets the customer.

Returnosid.resource.Resourcethe customer
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetItemIds
Description

Gets the Ids of the items.

Returnosid.id.IdListthe item Ids
CompliancemandatoryThis method must be implemented.
MethodgetItems
Description

Gets the items.

Returnosid.ordering.ItemListthe items
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTotalCost
Description

Gets the total cost for this order.

Returnosid.financials.Currencythe total cost
CompliancemandatoryThis method must be implemented.
MethodisAtomic
Description

Tests if all the items are processed atomically.

Returnboolean true if the order is atomic, false otherwise
CompliancemandatoryThis method must be implemented.
MethodisSubmitted
Description

Tests if all this order has been submitted.

Returnboolean true if the order has been submitted, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSubmitDate
Description

Gets the date submitted.

Returnosid.calendaring.DateTimethe date submitted
ErrorsILLEGAL_STATE isSubmitted() is false
CompliancemandatoryThis method must be implemented.
MethodgetSubmitterId
Description

Gets the resource Id who submitted the order.

Returnosid.id.Idthe submitting resource Id
ErrorsILLEGAL_STATE isSubmitted() is false
CompliancemandatoryThis method must be implemented.
MethodgetSubmitter
Description

Gets the agent who submitted the order.

Returnosid.resource.Resourcethe submitting resource
ErrorsILLEGAL_STATE isSubmitted() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetSubmittingAgentId
Description

Gets the agent Id who submitted the order.

Returnosid.id.Idthe submitting agent Id
ErrorsILLEGAL_STATE isSubmitted() is false
CompliancemandatoryThis method must be implemented.
MethodgetSubmittingAgent
Description

Gets the agent who submitted the order.

Returnosid.authentication.Agentthe submitting agent
ErrorsILLEGAL_STATE isSubmitted() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisClosed
Description

Tests if all this order is closed or canceled.

Returnboolean true if the order is closed, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetClosedDate
Description

Gets the date this order has been closed.

Returnosid.calendaring.DateTimethe date closed
ErrorsILLEGAL_STATE isClosed() is false
CompliancemandatoryThis method must be implemented.
MethodgetCloserId
Description

Gets the resource Id who closed the order.

Returnosid.id.Idthe closing resource Id
ErrorsILLEGAL_STATE isClosed() is false
CompliancemandatoryThis method must be implemented.
MethodgetCloser
Description

Gets the resource who closed the order.

Returnosid.resource.Resourcethe closing resource
ErrorsILLEGAL_STATE isClosed() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetClosingAgentId
Description

Gets the agent Id who closed the order.

Returnosid.id.Idthe closing agent Id
ErrorsILLEGAL_STATE isClosed() is false
CompliancemandatoryThis method must be implemented.
MethodgetClosingAgent
Description

Gets the agent who closed the order.

Returnosid.authentication.Agentthe closing agent
ErrorsILLEGAL_STATE isClosed() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetOrderRecord
Description

Gets the order record corresponding to the given 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 .

Parametersosid.type.TypeorderRecordTypethe type of order record to retrieve
Returnosid.ordering.records.OrderRecordthe order record
ErrorsNULL_ARGUMENT orderRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(orderRecordType) is false
CompliancemandatoryThis method must be implemented.