OSID - osid.voting.RaceLookupSession Service Interface Definition

Interface	osid.voting.RaceLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving races. A `Race` represents a statistic. 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 federated polls view: includes races in polls which are children of this polls in the polls hierarchy isolated polls view: restricts lookups to this polls only active race view: active races are returned from methods in this session any status race view: active and inactive races are returned from methods in this session
Method	getPollsId
Description	Gets the `Polls` `Id` associated with this session.
Return	`osid.id.Id`		the `Polls Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPolls
Description	Gets the `Polls` associated with this session.
Return	`osid.voting.Polls`		the polls
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupRaces
Description	Tests if this user can lookup races. 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 reading operations.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeRaceView
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	usePlenaryRaceView
Description	A complete view of the `Race` 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	useFederatedPollsView
Description	Federates the view for methods in this session. A federated view will include races in polls which are children of this polls in the polls hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPollsView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveRaceView
Description	Only active races are returned from methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusRaceView
Description	Borth active and inactive races are returned from methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getRace
Description	Gets the `Race` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Race` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Race` and retained for compatibility. In active mode, races are returned that are currently active. In any status mode, active and inactive races are returned.
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race` to retrieve
Return	`osid.voting.Race`		the returned `Race`
Errors	NOT_FOUND		no `Race` found with the given `Id`
	NULL_ARGUMENT		`raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRacesByIds
Description	Gets a `RaceList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the races 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 races may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, races are returned that are currently active. In any status mode, active and inactive races are returned.
Parameters	`osid.id.IdList`	`raceIds`	the list of `Ids` to retrieve
Return	`osid.voting.RaceList`		the returned `Race list`
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`raceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRacesByGenusType
Description	Gets a `RaceList` corresponding to the given race genus `Type` which does not include races of types derived from the specified `Type.` In plenary mode, the returned list contains all known races or an error results. Otherwise, the returned list may contain only those races that are accessible through this session.
Parameters	`osid.type.Type`	`raceGenusType`	a race genus type
Return	`osid.voting.RaceList`		the returned `Race` list
Errors	NULL_ARGUMENT		`raceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRacesByParentGenusType
Description	Gets a `RaceList` corresponding to the given race genus `Type` and include races of types derived from the specified `Type.` In plenary mode, the returned list contains all known races or an error results. Otherwise, the returned list may contain only those races that are accessible through this session. In active mode, races are returned that are currently active. In any status mode, active and inactive races are returned.
Parameters	`osid.type.Type`	`raceGenusType`	a race genus type
Return	`osid.voting.RaceList`		the returned `Race` list
Errors	NULL_ARGUMENT		`raceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRacesByRecordType
Description	Gets a `RaceList` containing the given race record `Type.` In plenary mode, the returned list contains all known races or an error results. Otherwise, the returned list may contain only those races that are accessible through this session. In active mode, races are returned that are currently active. In any status mode, active and inactive races are returned.
Parameters	`osid.type.Type`	`raceRecordType`	a race record type
Return	`osid.voting.RaceList`		the returned `Race` list
Errors	NULL_ARGUMENT		`raceRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRacesByProvider
Description	Gets a `RaceList` from the given provider. In plenary mode, the returned list contains all known races or an error results. Otherwise, the returned list may contain only those races that are accessible through this session. In active mode, races are returned that are currently active. In any status mode, active and inactive races are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.voting.RaceList`		the returned `Race` 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	getRacesForBallot
Description	Gets a `RaceList` for the given `Ballot.` In plenary mode, the returned list contains all known races or an error results. Otherwise, the returned list may contain only those races that are accessible through this session. In active mode, races are returned that are currently active. In any status mode, active and inactive races are returned.
Parameters	`osid.id.Id`	`ballotId`	a ballot `Id`
Return	`osid.voting.RaceList`		the returned `Race` list
Errors	NULL_ARGUMENT		`ballotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRaces
Description	Gets all races. In plenary mode, the returned list contains all known races or an error results. Otherwise, the returned list may contain only those races that are accessible through this session. In active mode, races are returned that are currently active. In any status mode, active and inactive races are returned.
Return	`osid.voting.RaceList`		a list of races
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.