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

Interface	osid.voting.rules.VoteEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.voting.rules.VoteEnablerSearchSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods for searching among `VoteEnabler` objects. The search query is constructed using the `VoteEnablerQuery` . This session defines views that offer differing behaviors for searching. federated polls view: searches include vote enablers in polls of which this polls is an ancestor in the polls hierarchy isolated polls view: searches are restricted to vote enablers in this polls Vote enablers may have a query record indicated by their respective record types. The query record is accessed via the `VoteEnablerQuery` .
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	canSearchVoteEnablers
Description	Tests if this user can perform `VoteEnabler` searches. 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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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 searches to this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	getVoteEnablerQuery
Description	Gets a vote enabler query.
Return	`osid.voting.rules.VoteEnablerQuery`		the vote enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablersByQuery
Description	Gets a list of `VoteEnablers` matching the given search.
Parameters	`osid.voting.rules.VoteEnablerQuery`	`voteEnablerQuery`	the vote enabler query
Return	`osid.voting.rules.VoteEnablerList`		the returned `VoteEnablerList`
Errors	NULL_ARGUMENT		`voteEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`voteEnablerQuery` did not originate from `getVoteEnablerQuery()`
Compliance	`mandatory`		This method must be implemented.