OSID - osid.voting.VoteSmartPollsSession Service Interface Definition

Interface	osid.voting.VoteSmartPollsSession
Implements	`osid.OsidSession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `VoteQuery` can be retrieved from this session and mapped to this `Polls` to create a virtual collection of `Votes`. The votes may be sequenced using the `VoteSearchOrder` from this session. This `Polls` has a default query that matches any vote and a default search order that specifies no sequencing. The queries may be examined using a `VoteQueryInspector`. The query may be modified by converting the inspector back to a `VoteQuery`.
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` associated with this session
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	getVoteQuery
Description	Gets a vote query.
Return	`osid.voting.VoteQuery`		the vote query
Compliance	`mandatory`		This method must be implemented.
Method	getVoteSearchOrder
Description	Gets a vote search order.
Return	`osid.voting.VoteSearchOrder`		the vote search order
Compliance	`mandatory`		This method must be implemented.
Method	applyVoteQuery
Description	Applies a vote query to this polls.
Parameters	`osid.voting.VoteQuery`	`voteQuery`	the vote query
Errors	NULL_ARGUMENT		`voteQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`voteQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectVoteQuery
Description	Gets a vote query inspector for this polls.
Return	`osid.voting.VoteQueryInspector`		the vote query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyVoteSequencing
Description	Applies a vote search order to this polls.
Parameters	`osid.voting.VoteSearchOrder`	`voteSearchOrder`	the vote search order
Errors	NULL_ARGUMENT		`voteSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`voteSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getVoteQueryFromInspector
Description	Gets a vote query from an inspector.
Parameters	`osid.voting.VoteQueryInspector`	`voteQueryInspector`	a vote query inspector
Return	`osid.voting.VoteQuery`		the vote query
Errors	NULL_ARGUMENT		`voteQueryInspector` is `null`
Errors	UNSUPPORTED		`voteQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.