Interface | osid.ordering.ItemAdminSession | ||
---|---|---|---|
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 | canCreateItems | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Item creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateItemWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | itemRecordTypes | array of item record types |
Return | boolean | true if Item creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | itemRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemFormForCreate | ||
Description |
Gets the item form for creating new items. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | orderId | the order Id |
osid.id.Id | productId | the product Id | |
osid.type.Type[] | itemRecordTypes | array of item record types | |
Return | osid.ordering.ItemForm | the item form | |
Errors | NOT_FOUND | orderId or productId is not found | |
NULL_ARGUMENT | orderId, productId or itemRecordTypes 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 | createItem | ||
Description |
Creates a new | ||
Parameters | osid.ordering.ItemForm | itemForm | the form for this Item |
Return | osid.ordering.Item | the new Item | |
Errors | ILLEGAL_STATE | itemForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | itemForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | itemForm did not originate from getItemForForCreate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateItems | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Item modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemFormForUpdate | ||
Description |
Gets the item form for updating an existing item. A new item form should be requested for each update transaction. | ||
Parameters | osid.id.Id | itemId | the Id of the Item |
Return | osid.ordering.ItemForm | the item form | |
Errors | NOT_FOUND | itemId is not found | |
NULL_ARGUMENT | itemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateItem | ||
Description |
Updates an existing item. | ||
Parameters | osid.ordering.ItemForm | itemForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | itemForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | itemForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | itemForm did not originate from getItemForForUpdate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteItems | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Item deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteItem | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | itemId | the Id of the Item to remove |
Errors | NOT_FOUND | itemId not found | |
NULL_ARGUMENT | itemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageItemAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Item aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasItem | ||
Description |
Adds an | ||
Parameters | osid.id.Id | itemId | the Id of an Item |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | itemId not found | ||
NULL_ARGUMENT | itemId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |