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

Interface	osid.voting.rules.BallotConstrainerSmartPollsSession
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 polls. A `BallotConstrainerQuery` can be retrieved from this session and mapped to this `Polls` to create a virtual collection of ballot constrainers. The ballot constrainer may be sequenced using the `BallotConstrainerSearchOrder` from this session. This `Polls` has a default query that matches any ballot constrainer and a default search order that specifies no sequencing. The queries may be examined using a `BallotConstrainerQueryInspector`. The query may be modified by converting the inspector back to a `BallotConstrainerQuery`.
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	getBallotConstrainerQuery
Description	Gets a ballot constrainer query.
Return	`osid.voting.rules.BallotConstrainerQuery`		the ballot constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerSearchOrder
Description	Gets a ballot constrainer search order.
Return	`osid.voting.rules.BallotConstrainerSearchOrder`		the ballot constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBallotConstrainerQuery
Description	Applies a ballot constrainer query to this polls.
Parameters	`osid.voting.rules.BallotConstrainerQuery`	`ballotConstrainerQuery`	the ballot constrainer query
Errors	NULL_ARGUMENT		`ballotConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`ballotConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBallotConstrainerQuery
Description	Gets a ballot constrainer query inspector for this polls.
Return	`osid.voting.rules.BallotConstrainerQueryInspector`		the ballot constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBallotConstrainerSequencing
Description	Applies a ballot constrainer search order to this polls.
Parameters	`osid.voting.rules.BallotConstrainerSearchOrder`	`ballotConstrainerSearchOrder`	the ballot constrainer search order
Errors	NULL_ARGUMENT		`ballotConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`ballotConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerQueryFromInspector
Description	Gets a ballot constrainer query from an inspector.
Parameters	`osid.voting.rules.BallotConstrainerQueryInspector`	`ballotConstrainerQueryInspector`	a ballot constrainer query inspector
Return	`osid.voting.rules.BallotConstrainerQuery`		the ballot constrainer query
Errors	NULL_ARGUMENT		`ballotConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`ballotConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.