OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.PersonLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving persons.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated realm view: All person methods in this session operate, retrieve and pertain to persons defined explicitly in the current realm. Using an isolated view is useful for managing persons with the PersonAdminSession.
  • federated realm view: All person lookup methods in this session operate, retrieve and pertain to all persons defined in this realm and any other realms implicitly available in this realm through realm inheritence.

The methods useFederatedRealmView() and useIsolatedRealmView() behave as a radio group and one should be selected before invoking any lookup methods.

MethodgetRealmId
Description

Gets the Realm Id associated with this session.

Returnosid.id.Idthe Realm Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRealm
Description

Gets the Realm associated with this session.

Returnosid.personnel.Realmthe realm
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupPersons
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations.

Returnboolean false if realm reading methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativePersonView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryPersonView
Description

A complete view of the Person returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedRealmView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedRealmView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this realm only.

CompliancemandatoryThis method is must be implemented.
MethodgetPerson
Description

Gets the Person specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Person may have a different Id than requested, such as the case where a duplicate Id was assigned to a Person and retained for compatibility.

Parametersosid.id.IdpersonIdthe Id of the Person to retrieve
Returnosid.personnel.Personthe returned Person
ErrorsNOT_FOUNDno Person found with the given Id
NULL_ARGUMENT personId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPersonsByIds
Description

Gets a PersonList corresponding to the given IdList. In plenary mode, the returned list contains all of the persons specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible persons may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListpersonIdsthe list of Ids to retrieve
Returnosid.personnel.PersonListthe returned Person list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT personIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPersonsByGenusType
Description

Gets a PersonList corresponding to the given person genus Type which does not include persons of types derived from the specified Type. 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.

Parametersosid.type.TypepersonGenusTypea persons genus type
Returnosid.personnel.PersonListthe returned Person list
ErrorsNULL_ARGUMENT personGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPersonsByParentGenusType
Description

Gets a PersonList corresponding to the given person genus Type and include any additional persons with genus types derived from the specified Type. 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.

Parametersosid.type.TypepersonGenusTypea person genus type
Returnosid.personnel.PersonListthe returned Person list
ErrorsNULL_ARGUMENT personGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPersonsByRecordType
Description

Gets a PersonList containing the given person record Type. 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.

Parametersosid.type.TypepersonRecordTypea person record type
Returnosid.personnel.PersonListthe returned PersonList
ErrorsNULL_ARGUMENT personRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPersons
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.

Returnosid.personnel.PersonLista list of persons
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.