Interface | osid.hold.rules.HoldEnablerOublietteAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignHoldEnablers | ||
Description |
Tests if this user can alter hold enabler/oubliette
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping 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 | canAssignHoldEnablersToOubliette | ||
Description |
Tests if this user can alter hold enabler/oubliette
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping 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 oubliette enabler can be assigned. | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
Return | osid.id.IdList | list of assignable hold Ids | |
Errors | NULL_ARGUMENT | oublietteId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableOublietteIdsForHoldEnabler | ||
Description |
Gets a list of oubliettes including and under the given oubliette node in which a specific oubliette enabler can be assigned. | ||
Parameters | osid.id.Id | oublietteId | the Id of the Oubliette |
osid.id.Id | holdEnablerId | the Id of the HoldEnabler | |
Return | osid.id.IdList | list of assignable oubliette Ids | |
Errors | NULL_ARGUMENT | oublietteId or holdEnablerId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignHoldEnablerToOubliette | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | holdEnablerId | the Id of the HoldEnabler |
osid.id.Id | oublietteId | the Id of the Oubliette | |
Errors | ALREADY_EXISTS | holdEnablerId is already assigned to oublietteId
| |
NOT_FOUND | holdEnablerId or oublietteId not found | ||
NULL_ARGUMENT | holdEnablerId or oublietteId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignHoldEnablerFromOubliette | ||
Description |
Removes a | ||
Parameters | osid.id.Id | holdEnablerId | the Id of the HoldEnabler |
osid.id.Id | oublietteId | the Id of the Oubliette | |
Errors | NOT_FOUND | holdEnablerId or oublietteId not found or
holdEnablerId is not assigned to oublietteId | |
NULL_ARGUMENT | holdEnablerId or oublietteId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignHoldEnablerToOubliette | ||
Description |
Moves a | ||
Parameters | osid.id.Id | holdEnablerId | the Id of the HoldEnabelr |
osid.id.Id | fromOublietteId | the Id of the current Oubliette | |
osid.id.Id | toOublietteId | the Id of the destination Oubliette | |
Errors | NOT_FOUND | holdEnabler, fromOublietteId, or toOublietteId
not found or holdEnablerId not mapped to
fromOublietteId | |
NULL_ARGUMENT | holdEnablerId, fromOublietteId, or toOublietteId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |