Interface | osid.personnel.PersonLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving persons. This lookup session defines several views:
The methods | ||
Method | getRealmId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Realm Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getRealm | ||
Description |
Gets the | ||
Return | osid.personnel.Realm | the realm | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupPersons | ||
Description |
Tests if this user can examine this realm. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this
session will result in a | ||
Return | boolean | false if realm reading methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativePersonView | ||
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 | usePlenaryPersonView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedRealmView | ||
Description |
Federates the view for methods in this session. A federated view will include persons in realms which are children of this realm in the realm hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedRealmView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this realm only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPerson | ||
Description |
Gets the | ||
Parameters | osid.id.Id | personId | the Id of the Person to retrieve |
Return | osid.personnel.Person | the returned Person | |
Errors | NOT_FOUND | no Person found with the given Id | |
NULL_ARGUMENT | personId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPersonsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | personIds | the list of Ids to retrieve |
Return | osid.personnel.PersonList | the returned Person list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | personIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPersonsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | personGenusType | a persons genus type |
Return | osid.personnel.PersonList | the returned Person list | |
Errors | NULL_ARGUMENT | personGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPersonsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | personGenusType | a person genus type |
Return | osid.personnel.PersonList | the returned Person list | |
Errors | NULL_ARGUMENT | personGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPersonsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | personRecordType | a person record type |
Return | osid.personnel.PersonList | the returned PersonList | |
Errors | NULL_ARGUMENT | personRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPersons | ||
Description |
Gets all persons. In plenary mode, the returned list contains all known persons or an error results. Otherwise, the returned list may contain only those persons that are accessible through this session. | ||
Return | osid.personnel.PersonList | a list of persons | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |