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

Interface	osid.voting.rules.VoteEnablerLookupSession
Implements	`osid.OsidSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods for retrieving `VoteEnablers` . 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 vote enabler methods in this session operate, retrieve and pertain to vote enablers defined explicitly in the current polls Using an isolated view is useful for managing `VoteEnablers` with the `VoteEnablerAdminSession` . federated polls view: All vote enabler methods in this session operate, retrieve and pertain to all vote enablers defined in this polls and any other vote enablers implicitly available in this polls through polls inheritence. 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 any lookup methods.
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	canLookupVoteEnablers
Description	Tests if this user can perform `VoteEnabler` 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	useComparativeVoteEnablerView
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	usePlenaryVoteEnablerView
Description	A complete view of the `VoteEnabler` 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 vote 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	getVoteEnabler
Description	Gets the `VoteEnabler` specified by its `Id` . In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `VoteEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `VoteEnabler and retai` ned for compatibility.
Parameters	`osid.id.Id`	`voteEnablerId`	`Id` of the `VoteEnabler`
Return	`osid.voting.rules.VoteEnabler`		the vote enabler
Errors	NOT_FOUND		`voteEnablerId` not found
	NULL_ARGUMENT		`voteEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getVoteEnablersByIds
Description	Gets a `VoteEnablerList` corresponding to the given `IdList` . In plenary mode, the returned list contains all of the vote enablers 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 `VoteEnablers may be omi` tted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`voteEnablerIds`	the list of `Ids` to retrieve
Return	`osid.voting.rules.VoteEnablerList`		the returned `VoteEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`voteEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablersByGenusType
Description	Gets a `VoteEnablerList` corresponding to the given vote enabler genus `Type` which does not include vote enablers of genus types derived from the specified `Type` . `In` plenary mode, the returned list contains all known vote enablers or an error results. Otherwise, the returned list may contain only those vote enablers that are accessible through this session.
Parameters	`osid.type.Type`	`voteEnablerGenusType`	a vote enabler genus type
Return	`osid.voting.rules.VoteEnablerList`		the returned `VoteEnabler` list
Errors	NULL_ARGUMENT		`voteEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablersByParentGenusType
Description	Gets a `VoteEnablerList` corresponding to the given vote enabler genus `Type` and include any additional vote enablers with genus types derived from the specified `Type` . `In` plenary mode, the returned list contains all known vote enablers or an error results. Otherwise, the returned list may contain only those vote enablers that are accessible through this session.
Parameters	`osid.type.Type`	`voteEnablerGenusType`	a vote genus type
Return	`osid.voting.rules.VoteEnablerList`		the returned `VoteEnabler` list
Errors	NULL_ARGUMENT		`voteEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablersByRecordType
Description	Gets a `VoteEnablerList` containing the given vote enabler record `Type` . `In` plenary mode, the returned list contains all known vote enablers or an error results. Otherwise, the returned list may contain only those vote enablers that are accessible through this session.
Parameters	`osid.type.Type`	`voteEnablerRecordType`	a vote enabler record type
Return	`osid.voting.rules.VoteEnablerList`		the returned `VoteEnabler` list
Errors	NULL_ARGUMENT		`voteEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablers
Description	Gets all `VoteEnablers` . In plenary mode, the returned list contains all known vote enablers or an error results. Otherwise, the returned list may contain only those vote enablers that are accessible through this session.
Return	`osid.voting.rules.VoteEnablerList`		a list of `VoteEnablers`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.