OSID - osid.recognition.AwardLookupSession Service Interface Definition

Interface	osid.recognition.AwardLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Award` objects. The `Award` represents a collection of conferrals. 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 view or is an error condition isolated academy view: All award methods in this session operate, retrieve and pertain to awards defined explicitly in the current academy. Using an isolated view is useful for managing awards with the `AwardAdminSession.` federated academy view: All award lookup methods in this session operate, retrieve and pertain to all awards defined in this academy and any other academies implicitly available in this academy through academy inheritence.
Method	getAcademyId
Description	Gets the `Academy` `Id` associated with this session.
Return	`osid.id.Id`		the `Academy Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAcademy
Description	Gets the `Academy` associated with this session.
Return	`osid.recognition.Academy`		the academy
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupAwards
Description	Tests if this user can perform `Award` 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	useComparativeAwardView
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	usePlenaryAwardView
Description	A complete view of the `Award` 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	useFederatedAcademyView
Description	Federates the view for methods in this session. A federated view will include awards in academies which are children of this academy in the academy hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAcademyView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAward
Description	Gets the `Award` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Award` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Award` and retained for compatibility.
Parameters	`osid.id.Id`	`awardId`	`Id` of the `Award`
Return	`osid.recognition.Award`		the award
Errors	NOT_FOUND		`awardId` not found
	NULL_ARGUMENT		`awardId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAwardsByIds
Description	Gets an `AwardList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the awards 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 `Awards` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`awardIds`	the list of `Ids` to retrieve
Return	`osid.recognition.AwardList`		the returned `Award` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`awardIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAwardsByGenusType
Description	Gets an `AwardList` corresponding to the given award genus `Type` which does not include awards of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session.
Parameters	`osid.type.Type`	`awardGenusType`	an award genus type
Return	`osid.recognition.AwardList`		the returned `Award` list
Errors	NULL_ARGUMENT		`awardGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAwardsByParentGenusType
Description	Gets an `AwardList` corresponding to the given award genus `Type` and include any additional awards with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session.
Parameters	`osid.type.Type`	`awardGenusType`	an award genus type
Return	`osid.recognition.AwardList`		the returned `Award` list
Errors	NULL_ARGUMENT		`awardGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAwardsByRecordType
Description	Gets an `AwardList` containing the given award record `Type.` In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session.
Parameters	`osid.type.Type`	`awardRecordType`	an award record type
Return	`osid.recognition.AwardList`		the returned `Award` list
Errors	NULL_ARGUMENT		`awardRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAwards
Description	Gets all `Awards.` In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session.
Return	`osid.recognition.AwardList`		a list of `Awards`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.