OSID - osid.voting.rules.RaceProcessorEnablerLookupSession Service Interface Definition

Interface	osid.voting.rules.RaceProcessorEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `RaceProcessorEnablers.` 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 set or is an error condition isolated polls view: All race processor enabler methods in this session operate, retrieve and pertain to race processor enablers defined explicitly in the current polls. Using an isolated view is useful for managing `RaceProcessorEnablers` with the `RaceProcessorEnablerAdminSession.` federated polls view: All race processor enabler methods in this session operate, retrieve and pertain to all race processor enablers defined in this polls and any other race processor enablers implicitly available in this polls through polls inheritence. active race processor enabler view: All race processor enabler lookup methods return active race processor enablers. any status race processor enabler view: Race processor enablers of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedPollsView()` and `useIsolatedPollsView()` behave as a radio group and one should be selected before invoking the 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	canLookupRaceProcessorEnablers
Description	Tests if this user can perform `RaceProcessorEnablers` 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 opt not to 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	useComparativeRaceProcessorEnablerView
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	usePlenaryRaceProcessorEnablerView
Description	A complete view of the `RaceProcessorEnabler` 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 race processor enablers 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 lookups to this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveRaceProcessorEnablerView
Description	Only active race processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusRaceProcessorEnablerView
Description	All active and inactive race processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getRaceProcessorEnabler
Description	Gets the `RaceProcessorEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `RaceProcessorEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `RaceProcessorEnabler` and retained for compatibility. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.
Parameters	`osid.id.Id`	`raceProcessorEnablerId`	`Id` of the `RaceProcessorEnabler`
Return	`osid.voting.rules.RaceProcessorEnabler`		the race processor enabler
Errors	NOT_FOUND		`raceProcessorEnablerId` not found
	NULL_ARGUMENT		`raceProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRaceProcessorEnablersByIds
Description	Gets a `RaceProcessorEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the race processor enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if a `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `RaceProcessorEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.
Parameters	`osid.id.IdList`	`raceProcessorEnablerIds`	the list of `Ids` to retrieve
Return	`osid.voting.rules.RaceProcessorEnablerList`		the returned `RaceProcessorEnabler` list
Errors	NOT_FOUND		a `Id` was not found
	NULL_ARGUMENT		`raceProcessorEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablersByGenusType
Description	Gets a `RaceProcessorEnablerList` corresponding to the given race processor enabler genus `Type` which does not include race processor enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known race processor enablers or an error results. Otherwise, the returned list may contain only those race processor enablers that are accessible through this session. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.
Parameters	`osid.type.Type`	`raceProcessorEnablerGenusType`	a race processor enabler genus type
Return	`osid.voting.rules.RaceProcessorEnablerList`		the returned `RaceProcessorEnabler` list
Errors	NULL_ARGUMENT		`raceProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablersByParentGenusType
Description	Gets a `RaceProcessorEnablerList` corresponding to the given race processor enabler genus `Type` and include any additional race processor enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known race processor enablers or an error results. Otherwise, the returned list may contain only those race processor enablers that are accessible through this session. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.
Parameters	`osid.type.Type`	`raceProcessorEnablerGenusType`	a race processor enabler genus type
Return	`osid.voting.rules.RaceProcessorEnablerList`		the returned `RaceProcessorEnabler` list
Errors	NULL_ARGUMENT		`raceProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablersByRecordType
Description	Gets a `RaceProcessorEnablerList` containing the given race processor enabler record `Type.` In plenary mode, the returned list contains all known race processor enablers or an error results. Otherwise, the returned list may contain only those race processor enablers that are accessible through this session. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.
Parameters	`osid.type.Type`	`raceProcessorEnablerRecordType`	a race processor enabler record type
Return	`osid.voting.rules.RaceProcessorEnablerList`		the returned `RaceProcessorEnabler` list
Errors	NULL_ARGUMENT		`raceProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablersOnDate
Description	Gets a `RaceProcessorEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known race processor enablers or an error results. Otherwise, the returned list may contain only those race processor enablers that are accessible through this session. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.voting.rules.RaceProcessorEnablerList`		the returned `RaceProcessorEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater tha `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	getRaceProcessorEnablersOnDateWithAgent
Description	Gets a `RaceProcessorEnablerList` that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known race processor enablers or an error results. Otherwise, the returned list may contain only those race processor enablers that are accessible through this session. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.voting.rules.RaceProcessorEnablerList`		the returned `RaceProcessorEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater tha `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablers
Description	Gets all `RaceProcessorEnablers.` In plenary mode, the returned list contains all known race processor enablers or an error results. Otherwise, the returned list may contain only those race processor enablers that are accessible through this session. In active mode, race processor enablers are returned that are currently active. In any status mode, active and inactive race processor enablers are returned.
Return	`osid.voting.rules.RaceProcessorEnablerList`		the returned `RaceProcessorEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.