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

Interface	osid.voting.rules.BallotConstrainerEnablerSmartPollsSession
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 `BallotConstrainerEnablerQuery` can be retrieved from this session and mapped to this `Polls` to create a virtual collection of ballot constrainer enablers. The ballot constrainer enablers may be sequenced using the `BallotConstrainerEnablerSearchOrder` from this session. This `Polls` has a default query that matches any ballot constrainer enabler and a default search order that specifies no sequencing. The queries may be examined using a `BallotConstrainerEnablerQueryInspector`. The query may be modified by converting the inspector back to a `BallotConstrainerEnablerQuery`.
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	getBallotConstrainerEnablerQuery
Description	Gets a ballot constrainer enabler query.
Return	`osid.voting.rules.BallotConstrainerEnablerQuery`		the ballot constrainer enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablerSearchOrder
Description	Gets a ballot constrainer enabler search order.
Return	`osid.voting.rules.BallotConstrainerEnablerSearchOrder`		the ballot constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBallotConstrainerEnablerQuery
Description	Applies a ballot constrainer enabler query to this polls.
Parameters	`osid.voting.rules.BallotConstrainerEnablerQuery`	`ballotConstrainerEnablerQuery`	the ballot constrainer enabler query
Errors	NULL_ARGUMENT		`ballotConstrainerEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`ballotConstrainerEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBallotConstrainerEnablerQuery
Description	Gets a ballot constrainer enabler query inspector for this polls.
Return	`osid.voting.rules.BallotConstrainerEnablerQueryInspector`		the ballot constrainer enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBallotConstrainerEnablerSequencing
Description	Applies a ballot constrainer enabler search order to this polls.
Parameters	`osid.voting.rules.BallotConstrainerEnablerSearchOrder`	`ballotConstrainerEnablerSearchOrder`	the ballot constrainer enabler search order
Errors	NULL_ARGUMENT		`ballotConstrainerEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`ballotConstrainerEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablerQueryFromInspector
Description	Gets a ballot constrainer enabler query from an inspector.
Parameters	`osid.voting.rules.BallotConstrainerEnablerQueryInspector`	`ballotConstrainerEnablerQueryInspector`	a ballot constrainer enabler query inspector
Return	`osid.voting.rules.BallotConstrainerEnablerQuery`		the ballot constrainer enabler query
Errors	NULL_ARGUMENT		`ballotConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`ballotConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.