OSID - osid.recognition.ConvocationLookupSession Service Interface Definition

Interface	osid.recognition.ConvocationLookupSession
Implements	`osid.OsidSession`
Used By	`osid.recognition.RecognitionManager`
Used By	`osid.recognition.RecognitionProxyManager`
Description	This session defines methods for retrieving convocations. 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 convocation methods in this session operate, retrieve and pertain to convocations defined explicitly in the current academy. Using an isolated view is useful for managing convocations with the `ConvocationAdminSession`. federated academy view: All convocation lookup methods in this session operate, retrieve and pertain to all convocations defined in this academy and any other academies implicitly available in this academy through academy inheritence. active convocation view: All convocation lookup methods return convocations where the convocation is active. any status convocation view: Convocations of any status 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	canLookupConvocations
Description	Tests if this user can lookup convocations. 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 convocation lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeConvocationView
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	usePlenaryConvocationView
Description	A complete view of the `Convocation` 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 convocations 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	useActiveConvocationView
Description	Only active convocations are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusConvocationView
Description	All convocations of any status are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getConvocation
Description	Gets the `Convocation` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Convocation` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Convocation` and retained for compatibility.
Parameters	`osid.id.Id`	`convocationId`	the `Id` of the `Convocation` to retrieve
Return	`osid.recognition.Convocation`		the returned `Convocation`
Errors	NOT_FOUND		no `Convocation` found with the given `Id`
	NULL_ARGUMENT		`convocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationsByIds
Description	Gets a `ConvocationList` corresponding to the given `IdList`.In plenary mode, the returned list contains all of the convocations 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 convocations may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`convocationIds`	the list of `Ids` to retrieve
Return	`osid.recognition.ConvocationList`		the returned `Convocation list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`convocationIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationsByGenusType
Description	Gets a `ConvocationList` corresponding to the given convocation genus `Type` which does not include convocations of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session.
Parameters	`osid.type.Type`	`convocationGenusType`	a convocation genus type
Return	`osid.recognition.ConvocationList`		the returned `Convocation` list
Errors	NULL_ARGUMENT		`convocationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationsByParentGenusType
Description	Gets a `ConvocationList` corresponding to the given convocation genus `Type` and include any additional convocations with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session.
Parameters	`osid.type.Type`	`convocationGenusType`	a convocation genus type
Return	`osid.recognition.ConvocationList`		the returned `Convocation` list
Errors	NULL_ARGUMENT		`convocationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationsByRecordType
Description	Gets a `ConvocationList` containing the given convocation record `Type`.In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session.
Parameters	`osid.type.Type`	`convocationRecordType`	a convocation record type
Return	`osid.recognition.ConvocationList`		the returned `Convocation` list
Errors	NULL_ARGUMENT		`convocationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationsByDate
Description	Gets a list of convocations with a date within the given date range inclusive. In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`from`	the starting date
Parameters	`osid.calendaring.DateTime`	`to`	the ending date
Return	`osid.recognition.ConvocationList`		the returned `ConvocationList`
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	getConvocationsByAward
Description	Gets a list of all convocations corresponding to an award `Id`. In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session.
Parameters	`osid.id.Id`	`awardId`	the `Id` of the award
Return	`osid.recognition.ConvocationList`		the returned `ConvocationList`
Errors	NULL_ARGUMENT		`awardId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationsByTimePeriod
Description	Gets a list of all convocations corresponding to a time period `Id`. In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session.
Parameters	`osid.id.Id`	`timePeriodId`	the `Id` of the time period
Return	`osid.recognition.ConvocationList`		the returned `ConvocationList`
Errors	NULL_ARGUMENT		`timePeriod` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConvocationsBySponsor
Description	Gets a list of all convocations for a given sponsor. In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
Return	`osid.recognition.ConvocationList`		the returned `ConvocationList`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getConvocations
Description	Gets all convocations. In plenary mode, the returned list contains all known convocations or an error results. Otherwise, the returned list may contain only those convocations that are accessible through this session.
Return	`osid.recognition.ConvocationList`		a list of convocations
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.