Interface | osid.personnel.PersonRealmAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignPersons | ||
Description |
Tests if this user can alter person/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 | canAssignPersonsToRealm | ||
Description |
Tests if this user can alter person/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 person 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 | getAssignableRealmIdsForPerson | ||
Description |
Gets a list of realms including and under the given realm node in which a specific person can be assigned. | ||
Parameters | osid.id.Id | realmId | the Id of the Realm |
osid.id.Id | personId | the Id of the Person | |
Return | osid.id.IdList | list of assignable realm Ids | |
Errors | NULL_ARGUMENT | realmId or personId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignPersonToRealm | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | personId | the Id of the Person |
osid.id.Id | realmId | the Id of the Realm | |
Errors | ALREADY_EXISTS | personId already assigned to realmId | |
NOT_FOUND | personId or realmId not found | ||
NULL_ARGUMENT | personId or realmId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignPersonFromRealm | ||
Description |
Removes a | ||
Parameters | osid.id.Id | personId | the Id of the Person |
osid.id.Id | realmId | the Id of the Realm | |
Errors | NOT_FOUND | personId or realmId not found or
personId not mapped to realmId | |
NULL_ARGUMENT | personId or realmId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |