Interface | osid.resource.BinAdminSession | ||
---|---|---|---|
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 | canCreateBins | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Bin creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateBinWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | binRecordTypes | array of bin record types |
Return | boolean | true if Bin creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | binRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBinFormForCreate | ||
Description |
Gets the bin form for creating new bins. | ||
Parameters | osid.type.Type[] | binRecordTypes | array of bin record types |
Return | osid.resource.BinForm | the bin form | |
Errors | NULL_ARGUMENT | binRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form with requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createBin | ||
Description |
Creates a new | ||
Parameters | osid.resource.BinForm | binForm | the form for this Bin |
Return | osid.resource.Bin | the new Bin | |
Errors | ILLEGAL_STATE | binForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | binForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | binForm did not originate from getBinFormForCreate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateBins | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Bin modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBinFormForUpdate | ||
Description |
Gets the bin form for updating an existing bin. A new bin form should be requested for each update transaction. | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
Return | osid.resource.BinForm | the bin form | |
Errors | NOT_FOUND | binId is not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBin | ||
Description |
Updates an existing bin. | ||
Parameters | osid.resource.BinForm | binForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | binForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | binId or binForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | binForm did not originate from getBinFormForUpdate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteBins | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Bin deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteBin | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | binId | the Id of the Bin to remove |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageBinAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Bin aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasBin | ||
Description |
Adds an | ||
Parameters | osid.id.Id | binId | the Id of a Bin |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | binId not found | ||
NULL_ARGUMENT | binId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |