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

Interface	osid.voting.rules.VoteEnablerSmartPollsSession
Implements	`osid.OsidSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `VoteEnablerQuery` can be retrieved from this session and mapped to this `Polls` to create a virtual collection of `VoteEnablers` . The vote enablers may be sequenced using the `VoteEnablerSearchOrder` from this session. This `Polls` has a default query that matches any vote enabler and a default search order that specifies no sequencing. The queries may be examined using a `VoteEnablerQueryInspector` . The query may be modified by converting the inspector back to a `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	canManageSmartPolls
Description	Tests if this user can manage smart polls. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart polls management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getVoteEnablerSearchOrder
Description	Gets a vote enabler search order.
Return	`osid.voting.rules.VoteEnablerSearchOrder`		the vote enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyVoteEnablerQuery
Description	Applies a vote enabler query to this polls.
Parameters	`osid.voting.rules.VoteEnablerQuery`	`voteEnablerQuery`	the vote enabler query
Errors	NULL_ARGUMENT		`voteEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`voteEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectVoteEnablerQuery
Description	Gets a vote enabler query inspector for this polls.
Return	`osid.voting.rules.VoteEnablerQueryInspector`		the vote enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyVoteEnablerSequencing
Description	Applies a vote enabler search order to this polls.
Parameters	`osid.voting.rules.VoteEnablerSearchOrder`	`voteEnablerSearchOrder`	the vote enabler search order
Errors	NULL_ARGUMENT		`voteEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`voteEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablerQueryFromInspector
Description	Gets a vote enabler query from an inspector.
Parameters	`osid.voting.rules.VoteEnablerQueryInspector`	`voteEnablerQueryInspector`	a vote enabler query inspector
Return	`osid.voting.VoteQuery`		the vote enabler query
Errors	NULL_ARGUMENT		`voteEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`voteEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.