Interface | osid.hold.HoldOublietteAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignHolds | ||
Description |
Tests if this user can alter hold/oubliette mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known issue methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignHoldsToOubliette | ||
Description |
Tests if this user can alter hold/oubliette mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known issue methods in this session will result in a
| ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | oublietteId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableOublietteIds | ||
Description |
Gets a list of oubliettes including and under the given oubliette node in which any hold can be assigned. | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
Return | osid.id.IdList | list of assignable oubliette Ids | |
Errors | NULL_ARGUMENT | oublietteId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableOublietteIdsForHold | ||
Description |
Gets a list of oubliettes including and under the given oubliette node in which a specific hold can be assigned. | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.id.Id | holdId | the Id of the Hold | |
Return | osid.id.IdList | list of assignable oubliette Ids | |
Errors | NULL_ARGUMENT | oublietteId or holdId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignHoldToOubliette | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | holdId | the Id of the Hold |
osid.id.Id | oublietteId | the Id of the Oubliette | |
Errors | ALREADY_EXISTS | holdId is already assigned to oublietteId | |
NOT_FOUND | holdId or oublietteId not found | ||
NULL_ARGUMENT | holdId or oublietteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignHoldFromOubliette | ||
Description |
Removes a | ||
Parameters | osid.id.Id | holdId | the Id of the Hold |
osid.id.Id | oublietteId | the Id of the Oubliette | |
Errors | NOT_FOUND | holdId or oublietteId not found or
holdId not assigned to oublietteId | |
NULL_ARGUMENT | holdId or oublietteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignHoldToOubliette | ||
Description |
Moves a | ||
Parameters | osid.id.Id | holdId | the Id of the Hold |
osid.id.Id | fromOublietteId | the Id of the current Oubliette | |
osid.id.Id | toOublietteId | the Id of the destination Oubliette | |
Errors | NOT_FOUND | holdId, fromOublietteId, or toOublietteId not
found or holdId not mapped to fromOublietteId | |
NULL_ARGUMENT | holdId, fromOublietteId, or toOublietteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |