OSID - osid.authentication.AgencyLookupSession Service Interface Definition

Interface	osid.authentication.AgencyLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Agency` objects. The `Agency` represents a collection of `Agents.` 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 Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the `Agencies` it can access, without breaking execution. However, an administrative application may require all `Agency` elements to be available. Agencies may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Agency.`
Method	canLookupAgencies
Description	Tests if this user can perform `Agency` 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 opt not to 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	useComparativeAgencyView
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	usePlenaryAgencyView
Description	A complete view of the `Agency` 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	getAgency
Description	Gets the `Agency` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Agency` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Agency` and retained for compatibility.
Parameters	`osid.id.Id`	`agencyId`	`Id` of the `Agency`
Return	`osid.authentication.Agency`		the agency
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAgenciesByIds
Description	Gets an `AgencyList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the agencies 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 `Agency` objects may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`agencyIds`	a list of agency `Ids`
Return	`osid.authentication.AgencyList`		the returned `Agency` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`agencyIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgenciesByGenusType
Description	Gets an `AgencyList` corresponding to the given agency genus `Type` which does not include agencies of types derived from the specified `Type.` In plenary mode, the returned list contains all known agencies or an error results. Otherwise, the returned list may contain only those agencies that are accessible through this session.
Parameters	`osid.type.Type`	`agencyGenusType`	an agency genus type
Return	`osid.authentication.AgencyList`		the returned `Agency` list
Errors	NULL_ARGUMENT		`agencyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgenciesByParentGenusType
Description	Gets an `AgencyList` corresponding to the given agency genus `Type` and include any additional agencies with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known agencies or an error results. Otherwise, the returned list may contain only those agencies that are accessible through this session.
Parameters	`osid.type.Type`	`agencyGenusType`	an agency genus type
Return	`osid.authentication.AgencyList`		the returned `Agency` list
Errors	NULL_ARGUMENT		`agencyGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgenciesByRecordType
Description	Gets an `AgencyList` containing the given agency record `Type.` In plenary mode, the returned list contains all known agencies or an error results. Otherwise, the returned list may contain only those agencies that are accessible through this session.
Parameters	`osid.type.Type`	`agencyRecordType`	an agency record type
Return	`osid.authentication.AgencyList`		the returned `Agency` list
Errors	NULL_ARGUMENT		`agencyRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAgenciesByProvider
Description	Gets an `AgencyList` from the given provider. In plenary mode, the returned list contains all known agencies or an error results. Otherwise, the returned list may contain only those agencies that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.authentication.AgencyList`		the returned `Agency` 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	getAgencies
Description	Gets all `Agencies.` In plenary mode, the returned list contains all known agencies or an error results. Otherwise, the returned list may contain only those agencies that are accessible through this session.
Return	`osid.authentication.AgencyList`		an `AgencyList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.