Interface | osid.personnel.PositionRealmAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignPositions | ||
Description |
Tests if this user can alter position/realm 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 | canAssignPositionsToRealm | ||
Description |
Tests if this user can alter position/realm 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 | realmId | the Id of the Realm |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | realmId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableRealmIds | ||
Description |
Gets a list of realms including and under the given realm node in which any position can be assigned. | ||
Parameters | osid.id.Id | realmId | the Id of the Realm |
Return | osid.id.IdList | list of assignable realm Ids | |
Errors | NULL_ARGUMENT | realmId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableRealmIdsForPosition | ||
Description |
Gets a list of realms including and under the given realm node in which a specific position can be assigned. | ||
Parameters | osid.id.Id | realmId | the Id of the Realm |
osid.id.Id | positionId | the Id of the Position | |
Return | osid.id.IdList | list of assignable realm Ids | |
Errors | NULL_ARGUMENT | realmId or positionId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignPositionToRealm | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | positionId | the Id of the Position |
osid.id.Id | realmId | the Id of the Realm | |
Errors | ALREADY_EXISTS | positionId already assigned to realmId | |
NOT_FOUND | positionId or realmId not found | ||
NULL_ARGUMENT | positionId or realmId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignPositionFromRealm | ||
Description |
Removes a | ||
Parameters | osid.id.Id | positionId | the Id of the Position |
osid.id.Id | realmId | the Id of the Realm | |
Errors | NOT_FOUND | positionId or realmId not found or
positionId not mapped to realmId | |
NULL_ARGUMENT | positionId or realmId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |