OSID - osid.voting.CandidateSmartPollsSession Service Interface Definition

Interface	osid.voting.CandidateSmartPollsSession
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 `CandidateQuery` can be retrieved from this session and mapped to this `Polls` to create a virtual collection of `Candidates` . The candidates may be sequenced using the `CandidateSearchOrder` from this session. This `Polls` has a default query that matches any candidate and a default search order that specifies no sequencing. The queries may be examined using a `CandidateQueryInspector` . The query may be modified by converting the inspector back to a `CandidateQuery` .
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	getCandidateQuery
Description	Gets a candidate query.
Return	`osid.voting.CandidateQuery`		the candidate query
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateSearchOrder
Description	Gets a candidate search order.
Return	`osid.voting.CandidateSearchOrder`		the candidate search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCandidateQuery
Description	Applies a candidate query to this polls.
Parameters	`osid.voting.CandidateQuery`	`candidateQuery`	the candidate query
Errors	NULL_ARGUMENT		`candidateQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`candidateQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCandidateQuery
Description	Gets a candidate query inspector for this polls.
Return	`osid.voting.CandidateQueryInspector`		the candidate query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCandidateSequencing
Description	Applies a candidate search order to this polls.
Parameters	`osid.voting.CandidateSearchOrder`	`candidateSearchOrder`	the candidate search order
Errors	NULL_ARGUMENT		`candidateSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`candidateSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateQueryFromInspector
Description	Gets a candidate query from an inspector.
Parameters	`osid.voting.CandidateQueryInspector`	`candidateQueryInspector`	a candidate query inspector
Return	`osid.voting.CandidateQuery`		the candidate query
Errors	NULL_ARGUMENT		`candidateQueryInspector` is `null`
Errors	UNSUPPORTED		`candidateQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.