OSID - osid.recognition.ConferralLookupSession Service Interface Definition

Interface	osid.recognition.ConferralLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving conferrals. 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 academy view: All conferral methods in this session operate, retrieve and pertain to conferrals defined explicitly in the current academy. Using an isolated view is useful for managing conferrals with the `ConferralAdminSession.` federated academy view: All conferral lookup methods in this session operate, retrieve and pertain to all conferrals defined in this academy and any other academies implicitly available in this academy through academy inheritence. effective conferral view: All conferral lookup methods return conferrals where the current dates falls in between the effective dates inclusive. any effective conferral view: Conferrals of any effective date are returned. The methods `useFederatedAcademyView()` and `useIsolatedAcademyView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupConferrals
Description	Tests if this user can lookup conferrals. 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 conferral lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeConferralView
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	usePlenaryConferralView
Description	A complete view of the `Conferral` 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 conferrals 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	useEffectiveConferralView
Description	Only conferrals whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveConferralView
Description	All conferrals of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getConferral
Description	Gets the `Conferral` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Conferral` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Conferral` and retained for compatibility. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`conferralId`	the `Id` of the `Conferral` to retrieve
Return	`osid.recognition.Conferral`		the returned `Conferral`
Errors	NOT_FOUND		no `Conferral` found with the given `Id`
	NULL_ARGUMENT		`conferralId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsByIds
Description	Gets a `ConferralList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the conferrals 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 conferrals may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.IdList`	`conferralIds`	the list of `Ids` to retrieve
Return	`osid.recognition.ConferralList`		the returned `Conferral list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`conferralIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsByGenusType
Description	Gets a `ConferralList` corresponding to the given conferral genus `Type` which does not include conferrals of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.type.Type`	`conferralGenusType`	a conferral genus type
Return	`osid.recognition.ConferralList`		the returned `Conferral` list
Errors	NULL_ARGUMENT		`conferralGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsByParentGenusType
Description	Gets a `ConferralList` corresponding to the given conferral genus `Type` and include any additional conferrals with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.type.Type`	`conferralGenusType`	a conferral genus type
Return	`osid.recognition.ConferralList`		the returned `Conferral` list
Errors	NULL_ARGUMENT		`conferralGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsByRecordType
Description	Gets a `ConferralList` containing the given conferral record `Type.` In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.type.Type`	`conferralRecordType`	a conferral record type
Return	`osid.recognition.ConferralList`		the returned `Conferral` list
Errors	NULL_ARGUMENT		`conferralRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsOnDate
Description	Gets a list of conferrals effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	the starting date
Parameters	`osid.calendaring.DateTime`	`to`	the ending date
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsForRecipient
Description	Gets a list of conferrals corresponding to a resource `Id.` In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsForRecipientOnDate
Description	Gets a list of all conferrals corresponding to a resource `Id` and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsForAward
Description	Gets a list of all conferrals corresponding to an award `Id.` In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`awardId`	the `Id` of the award
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	NULL_ARGUMENT		`awardId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsForAwardOnDate
Description	Gets a list of all conferrals corresponding to an award `Id` and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`awardId`	an award `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`awardId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsForRecipientAndAward
Description	Gets a list of conferralsfor the given resource and award. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
Parameters	`osid.id.Id`	`awardid`	the Id of the award
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	NULL_ARGUMENT		`resourceId` or `awardId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsForRecipientAndAwardOnDate
Description	Gets a list of all conferrals for the given resource, award, and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`awardid`	an award `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, awardid, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsByReference
Description	Gets a list of conferrals corresponding to a reference `Id.` In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsByReferenceOnDate
Description	Gets a list of all conferrals corresponding to a reference `Id` and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`referenceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsByConvocation
Description	Gets a list of all conferrals corresponding to a convocation `Id.` In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`convocationId`	the `Id` of the convocation
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	NULL_ARGUMENT		`convocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferralsByConvocationOnDate
Description	Gets a list of all conferrals corresponding to a convocation `Id` and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Parameters	`osid.id.Id`	`convocationId`	a convocation `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.recognition.ConferralList`		the returned `ConferralList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`convocationId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConferrals
Description	Gets all conferrals. In plenary mode, the returned list contains all known conferrals or an error results. Otherwise, the returned list may contain only those conferrals that are accessible through this session. In effective mode, conferrals are returned that are currently effective. In any effective mode, effective conferrals and those currently expired are returned.
Return	`osid.recognition.ConferralList`		a list of conferrals
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.