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

Interface	osid.voting.rules.BallotConstrainerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `BallotConstrainer` to `Ballot` mappings. A `Ballot` with multiple `BallotConstrainers` means any positive rule evaluation across the constrainers result in an accessible `Ballot.` This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated polls view: All methods in this session operate, retrieve and pertain ballot constrainer defined explicitly in the current polls federated polls view: All methods in this session operate, retrieve and pertain to all ballot constrainer defined in this polls and any other ballot constrainer implicitly available in this polls through polls inheritence.
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	canLookupBallotConstrainerRules
Description	Tests if this user can perform lookups of ballot constrainer/ballot mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBallotConstrainerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryBallotConstrainerRuleView
Description	A complete view of the `BallotConstrainer` and `Ballot` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedPollsView
Description	Federates the view for methods in this session. A federated view will include ballot constrainer in polls which are children of this polls in the polls hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPollsView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	getBallotConstrainerIdsForBallot
Description	Gets the `BallotConstrainer Id` associated with a `Ballot.`
Parameters	`osid.id.Id`	`ballotId`	`Id` of the `Ballot`
Return	`osid.id.IdList`		the ballot constrainer `Ids`
Errors	NOT_FOUND		`ballotId` is not found
	NULL_ARGUMENT		`ballotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainersForBallot
Description	Gets the `BallotConstrainer` associated with a `Ballot.`
Parameters	`osid.id.Id`	`ballotId`	`Id` of the `Ballot`
Return	`osid.voting.rules.BallotConstrainerList`		the ballot constrainers
Errors	NOT_FOUND		`ballotId` is not found
	NULL_ARGUMENT		`ballotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotIdsForBallotConstrainer
Description	Gets the `Ballot` `Ids` mapped to a `BallotConstrainer.`
Parameters	`osid.id.Id`	`ballotConstrainerId`	`Id` of a `BallotConstrainer`
Return	`osid.id.IdList`		list of ballot `Ids`
Errors	NOT_FOUND		`ballotConstrainerId` is not found
	NULL_ARGUMENT		`ballotConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotsForBallotConstrainer
Description	Gets the `Ballots` mapped to a `BallotConstrainer.`
Parameters	`osid.id.Id`	`ballotConstrainerId`	`Id` of a `BallotConstrainer`
Return	`osid.voting.BallotList`		list of ballots
Errors	NOT_FOUND		`ballotConstrainerId` is not found
	NULL_ARGUMENT		`ballotConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.