OSID - osid.personnel.RealmLookupSession Service Interface Definition

Interface	osid.personnel.RealmLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Realm` objects. The `Realm` represents a collection of `Persons.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	canLookupRealms
Description	Tests if this user can perform `Realm` lookups. 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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are 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 `Realm` 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	getRealm
Description	Gets the `Realm` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Realm` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Realm` and retained for compatibility.
Parameters	`osid.id.Id`	`realmId`	`Id` of the `Realm`
Return	`osid.personnel.Realm`		the realm
Errors	NOT_FOUND		`realmId` not found
	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRealmsByIds
Description	Gets a `RealmList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the realms 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 `Realms` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`realmIds`	the list of `Ids` to retrieve
Return	`osid.personnel.RealmList`		the returned `Realm` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`realmIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRealmsByGenusType
Description	Gets a `RealmList` corresponding to the given realm genus `Type` which does not include realms of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known realms or an error results. Otherwise, the returned list may contain only those realms that are accessible through this session.
Parameters	`osid.type.Type`	`realmGenusType`	a realm genus type
Return	`osid.personnel.RealmList`		the returned `Realm` list
Errors	NULL_ARGUMENT		`realmGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRealmsByParentGenusType
Description	Gets a `RealmList` corresponding to the given realm genus `Type` and include any additional realms with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known realms or an error results. Otherwise, the returned list may contain only those realms that are accessible through this session.
Parameters	`osid.type.Type`	`realmGenusType`	a realm genus type
Return	`osid.personnel.RealmList`		the returned `Realm` list
Errors	NULL_ARGUMENT		`realmGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRealmsByRecordType
Description	Gets a `RealmList` containing the given realm record `Type.` In plenary mode, the returned list contains all known realms or an error results. Otherwise, the returned list may contain only those realms that are accessible through this session.
Parameters	`osid.type.Type`	`realmRecordType`	a realm record type
Return	`osid.personnel.RealmList`		the returned `Realm` list
Errors	NULL_ARGUMENT		`realmRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRealmsByProvider
Description	Gets a `RealmList` for the given provider. In plenary mode, the returned list contains all known realms or an error results. Otherwise, the returned list may contain only those realms that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource Id
Return	`osid.personnel.RealmList`		the returned `Realm` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRealms
Description	Gets all `Realms.` In plenary mode, the returned list contains all known realms or an error results. Otherwise, the returned list may contain only those realms that are accessible through this session.
Return	`osid.personnel.RealmList`		a list of `Realms`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.