Interface | osid.ordering.StoreAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | canCreateStores | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Store creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateStoreWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | storeRecordTypes | array of store record types |
Return | boolean | true if Store creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | storeRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getStoreFormForCreate | ||
Description |
Gets the store form for creating new stores. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | storeRecordTypes | array of store record types |
Return | osid.ordering.StoreForm | the store form | |
Errors | NULL_ARGUMENT | storeRecordTypes 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 | createStore | ||
Description |
Creates a new | ||
Parameters | osid.ordering.StoreForm | storeForm | the form for this Store |
Return | osid.ordering.Store | the new Store | |
Errors | ILLEGAL_STATE | storeForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | storeForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | storeForm did not originate from
getStoreFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateStores | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Store modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStoreFormForUpdate | ||
Description |
Gets the store form for updating an existing store. A new store form should be requested for each update transaction. | ||
Parameters | osid.id.Id | storeId | the Id of the Store |
Return | osid.ordering.StoreForm | the store form | |
Errors | NULL_ARGUMENT | storeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | updateStore | ||
Description |
Updates an existing store. | ||
Parameters | osid.ordering.StoreForm | storeForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | storeForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | storeForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | storeForm did not originate from
getStoreFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteStores | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Store deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteStore | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | storeId | the Id of the Store to remove |
Errors | NOT_FOUND | storeId not found | |
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageStoreAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Store aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasStore | ||
Description |
Adds an | ||
Parameters | osid.id.Id | storeId | the Id of a Store |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | storeId not found | ||
NULL_ARGUMENT | storeId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |