Interface | osid.personnel.PersonRealmSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupPersonRealmMappings | ||
Description |
Tests if this user can perform lookups of person/realm
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known lookup methods in this session will result in a
| ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeRealmView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryRealmView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPersonIdsByRealm | ||
Description |
Gets the list of Person Ids associated with a | ||
Parameters | osid.id.Id | realmId | Id of a Realms. |
Return | osid.id.IdList | list of related person Ids | |
Errors | NOT_FOUND | realmId is not found | |
NULL_ARGUMENT | realmId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPersonsByRealm | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | realmId | Id of a Realm |
Return | osid.personnel.PersonList | list of related persons | |
Errors | NOT_FOUND | realmId is not found | |
NULL_ARGUMENT | realmId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPersonIdsByRealms | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | realmIds | list of realm Ids |
Return | osid.id.IdList | list of person Ids | |
Errors | NULL_ARGUMENT | realmIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPersonsByRealms | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | realmIds | list of realm Ids |
Return | osid.personnel.PersonList | list of persons | |
Errors | NULL_ARGUMENT | realmIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRealmIdsByPerson | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | personId | Id of a Person |
Return | osid.id.IdList | list of realm Ids | |
Errors | NOT_FOUND | personId is not found | |
NULL_ARGUMENT | personId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRealmsByPerson | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | personId | Id of a Person |
Return | osid.personnel.RealmList | list of realms | |
Errors | NOT_FOUND | personId is not found | |
NULL_ARGUMENT | personId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |