OSID - osid.personnel.PersonLookupSession Service Interface Definition

Interface	osid.personnel.PersonLookupSession
Implements	`osid.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.
Method	getRealmId
Description	Gets the `Realm` `Id` associated with this session.
Return	`osid.id.Id`		the `Realm Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRealm
Description	Gets the `Realm` associated with this session.
Return	`osid.personnel.Realm`		the realm
Errors	OPERATION_FAILED		unable to complete request
Errors	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 `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer these operations.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
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
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.