Interface | osid.installation.DepotAdminSession | ||
---|---|---|---|
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 | ||
Method | canCreateDepots | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Depot creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateDepotWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | depotRecordTypes | array of depot record types |
Return | boolean | true if Depot creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | depotRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDepotFormForCreate | ||
Description |
Gets the depot form for creating new depots. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | depotRecordTypes | array of depot record types |
Return | osid.installation.DepotForm | the depot form | |
Errors | NULL_ARGUMENT | depotRecordTypes 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 | createDepot | ||
Description |
Creates a new | ||
Parameters | osid.installation.DepotForm | depotForm | the form for this Depot |
Return | osid.installation.Depot | the new Depot | |
Errors | ILLEGAL_STATE | depotForm already used for a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | depotForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | depotForm did not originate from
getDepotFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateDepots | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Depot modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateDepot | ||
Description |
Tests if this user can update a specified | ||
Parameters | osid.id.Id | depotId | the Id of the Depot |
Return | boolean | false if depot modification is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | depotId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | getDepotFormForUpdate | ||
Description |
Gets the depot form for updating an existing depot. A new depot form should be requested for each update transaction. | ||
Parameters | osid.id.Id | depotId | the Id of the Depot |
Return | osid.installation.DepotForm | the depot form | |
Errors | NOT_FOUND | depotId is not found | |
NULL_ARGUMENT | depotId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateDepot | ||
Description |
Updates an existing depot. | ||
Parameters | osid.installation.DepotForm | depotForm | the form containing the elements to be updated |
Errors | INVALID_ARGUMENT | the form contains an invalid value | |
NULL_ARGUMENT | depotForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | depotForm did not originate from
getDepotFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteDepots | ||
Description |
Tests if this user can delete depots. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known deleting a | ||
Return | boolean | false if Depot deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteDepot | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | depotId | the Id of the Depot |
Return | boolean | false if deletion of this Depot is not
authorized, true otherwise | |
Errors | NULL_ARGUMENT | depotId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteDepot | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | depotId | the Id of the Depot to remove |
Errors | NOT_FOUND | depotId not found | |
NULL_ARGUMENT | depotId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageDepotAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Depot aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasDepot | ||
Description |
Adds an | ||
Parameters | osid.id.Id | depotId | the Id of a Depot |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | depotId not found | ||
NULL_ARGUMENT | depotId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |