Interface | osid.ordering.OrderAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | getStoreId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Store Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getStore | ||
Description |
Gets the | ||
Return | osid.ordering.Store | the store | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateOrders | ||
Description |
Tests if this user can create order entries. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating an
| ||
Return | boolean | false if Order creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateOrderWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | orderRecordTypes | array of order record types |
Return | boolean | true if Order creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | orderRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrderFormForCreate | ||
Description |
Gets the order form for creating new entries. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | orderRecordTypes | array of order record types |
Return | osid.ordering.OrderForm | the order form | |
Errors | NULL_ARGUMENT | orderRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createOrder | ||
Description |
Creates a new | ||
Parameters | osid.ordering.OrderForm | orderForm | the form for this Order |
Return | osid.ordering.Order | the new Order | |
Errors | ILLEGAL_STATE | orderForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | orderForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | orderForm did not originate from
getOrderFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateOrders | ||
Description |
Tests if this user can update orders. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known updating an | ||
Return | boolean | false if Order modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrderFormForUpdate | ||
Description |
Gets the order form for updating an existing order. A new order form should be requested for each update transaction. | ||
Parameters | osid.id.Id | orderId | the Id of the Order |
Return | osid.ordering.OrderForm | the order form | |
Errors | NOT_FOUND | orderId is not found | |
NULL_ARGUMENT | orderId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateOrder | ||
Description |
Updates an existing order. | ||
Parameters | osid.ordering.OrderForm | orderForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | orderForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | orderForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | orderForm did not originate from
getOrderFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteOrders | ||
Description |
Tests if this user can delete orders. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known deleting an | ||
Return | boolean | false if Order deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteOrder | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | orderId | the Id of the Order to remove |
Errors | NOT_FOUND | orderId not found | |
NULL_ARGUMENT | orderId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageOrderAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Order aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasOrder | ||
Description |
Adds an | ||
Parameters | osid.id.Id | orderId | the Id of an Order |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | orderId not found | ||
NULL_ARGUMENT | orderId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |