OSID - osid.offering.ResultLookupSession Service Interface Definition

Interface	osid.offering.ResultLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving results. 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 catalogue view: All result methods in this session operate, retrieve and pertain to results defined explicitly in the current catalogue. Using an isolated view is useful for managing results with the `ResultAdminSession.` federated catalogue view: All result lookup methods in this session operate, retrieve and pertain to all results defined in this catalogue and any other catalogues implicitly available in this catalogue through catalogue inheritence. effective result view: All result lookup methods return results where the current date falls in between the effective dates inclusive. any effective result view: Results of any effective date are returned from methods. The methods `useFederatedCatalogueView()` and `useIsolatedCatalogueView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupResults
Description	Tests if this user can examine this catalogue. 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 catalogue reading methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeResultView
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	usePlenaryResultView
Description	A complete view of the `Result` 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	useFederatedCatalogueView
Description	Federates the view for methods in this session. A federated view will include results in catalogues which are children of this catalogue in the catalogue hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogueView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveResultView
Description	Only results whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveResultView
Description	All results of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getResult
Description	Gets the `Result` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Result` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Result` and retained for compatibility. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.id.Id`	`resultId`	the `Id` of the `Result` to retrieve
Return	`osid.offering.Result`		the returned `Result`
Errors	NOT_FOUND		no `Result` found with the given `Id`
	NULL_ARGUMENT		`resultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResultsByIds
Description	Gets an `ResultList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the results 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 results may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.id.IdList`	`resultIds`	the list of `Ids` to retrieve
Return	`osid.offering.ResultList`		the returned `Result list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`resultIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResultsByGenusType
Description	Gets an `ResultList` corresponding to the given result genus `Type` which does not include results of types derived from the specified `Type.` In plenary mode, the returned list contains all known results or an error results. Otherwise, the returned list may contain only those results that are accessible through this session. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.type.Type`	`resultGenusType`	an results genus type
Return	`osid.offering.ResultList`		the returned `Result list`
Errors	NULL_ARGUMENT		`resultGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResultsByParentGenusType
Description	Gets an `ResultList` corresponding to the given result genus `Type` and include any additional results with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known results or an error results. Otherwise, the returned list may contain only those results that are accessible through this session. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.type.Type`	`resultGenusType`	a result genus type
Return	`osid.offering.ResultList`		the returned `Result list`
Errors	NULL_ARGUMENT		`resultGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResultsByRecordType
Description	Gets an `ResultList` containing the given result record `Type.` In plenary mode, the returned list contains all known results or an error results. Otherwise, the returned list may contain only those results that are accessible through this session. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.type.Type`	`resultRecordType`	an result record type
Return	`osid.offering.ResultList`		the returned `ResultList`
Errors	NULL_ARGUMENT		`resultRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResultsOnDate
Description	Gets an `ResultList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known results or an error results. Otherwise, the returned list may contain only those results that are accessible through this session. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ResultList`		the returned `ResultList`
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	getResultsByGenusTypeOnDate
Description	Gets an `ResultList` by genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known results or an error results. Otherwise, the returned list may contain only those results that are accessible through this session. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.type.Type`	`resultGenusType`	a results genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ResultList`		the returned `ResultList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resultGenusType, from or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResultsForParticipant
Description	Gets an `ResultList` for the given participant `Id.` In plenary mode, the returned list contains all of the results corresponding to the given participant, including duplicates, or an error results if an result is inaccessible. Otherwise, inaccessible `Results` may be omitted from the list. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.id.Id`	`participantId`	a participant `Id`
Return	`osid.offering.ResultList`		the returned `ResultList`
Errors	NULL_ARGUMENT		`participantId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResultsByGenusTypeForParticipant
Description	Gets an `ResultList` for the given participant `Id.` In plenary mode, the returned list contains all of the results corresponding to the given participant, including duplicates, or an error results if an result is inaccessible. Otherwise, inaccessible `Results` may be omitted from the list. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.id.Id`	`participantId`	a participant `Id`
Parameters	`osid.type.Type`	`resultGenusType`	a results genus type
Return	`osid.offering.ResultList`		the returned `ResultList`
Errors	NULL_ARGUMENT		`participantId` or `resultGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResultsForParticipantOnDate
Description	Gets a list of results for a participant 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 results or an error results. Otherwise, the returned list may contain only those results that are accessible through this session. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.id.Id`	`participantId`	a participant `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ResultList`		the returned `ResultList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`participantId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResultsByGenusTypeForParticipantOnDate
Description	Gets a list of results for a participant 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 results or an error results. Otherwise, the returned list may contain only those results that are accessible through this session. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Parameters	`osid.id.Id`	`participantId`	a participant `Id`
	`osid.type.Type`	`resultGenusType`	a results genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ResultList`		the returned `ResultList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`participantId, resultGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResults
Description	Gets all results. In plenary mode, the returned list contains all known results or an error results. Otherwise, the returned list may contain only those results that are accessible through this session. In effective mode, results are returned that are currently effective. In any effective mode, effective results and those currently expired are returned.
Return	`osid.offering.ResultList`		a list of results
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.