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

Interface	osid.voting.rules.VoteEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods to apply `VoteEnablers` to `Votes` . Multiple `VoteEnablers` applied to an `Vote` may be sequenced such that the first positive evaluation results in the `VoteEnablers` used.
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	canAssignVoteEnablers
Description	Tests if this user can alter vote enabler/vote mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignVoteEnablerToVote
Description	Adds an existing `VoteEnabler` to a `Vote` .
Parameters	`osid.id.Id`	`voteEnablerId`	the `Id` of the `VoteEnabler`
Parameters	`osid.id.Id`	`voteId`	the `Id` of the `Vote`
Errors	ALREADY_EXISTS		`voteEnablerId` already applied to `voteId`
	NOT_FOUND		`voteEnablerId` or `voteId` not found
	NULL_ARGUMENT		`voteEnablerId` or `voteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignVoteEnablerFromVote
Description	Removes an existing `VoteEnabler` from a `Vote` .
Parameters	`osid.id.Id`	`voteEnablerId`	the `Id` of the `VoteEnabler`
Parameters	`osid.id.Id`	`voteId`	the `Id` of the `Vote`
Errors	NOT_FOUND		`voteEnablerId` or `voteId` not found or `voteEnablerId` already applied to `voteId`
	NULL_ARGUMENT		`voteEnablerId` or `voteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceVoteEnablers
Description	Tests if this user can order `VoteEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `VoteEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveVoteEnablerAhead
Description	Reorders vote enablers for a vote by moving the specified vote enabler in front of a reference vote enabler.
Parameters	`osid.id.Id`	`voteEnablerId`	the `Id` of the `VoteEnabler`
	`osid.id.Id`	`voteId`	the `Id` of the `Vote`
	`osid.id.Id`	`referenceId`	the reference vote enabler `Id`
Errors	NOT_FOUND		`voteEnablerId, voteId` , or `referenceId` not found or, `voteEnablerId` or `referenceId` not related to `voteId`
	NULL_ARGUMENT		`voteEnablerId, voteId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveVoteEnablerBehind
Description	Reorders vote enablers for a vote by moving the specified vote enabler behind a reference vote enabler.
Parameters	`osid.id.Id`	`voteEnablerId`	the `Id` of the `VoteEnabler`
	`osid.id.Id`	`voteId`	the `Id` of the `Vote`
	`osid.id.Id`	`referenceId`	the reference vote enabler `Id`
Errors	NOT_FOUND		`voteEnablerId, voteId` , or `referenceId` not found or, `voteEnablerId` or `referenceId` not related to `voteId`
	NULL_ARGUMENT		`voteEnablerId, voteId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderVoteEnablers
Description	Reorders a set of vote enablers for a vote.
Parameters	`osid.id.Id[]`	`voteEnablerIds`	the `Ids` for a set of `VoteEnablers`
Parameters	`osid.id.Id`	`voteId`	the `Id` of the `Vote`
Errors	NOT_FOUND		`voteEnablerId, voteId` , or `referenceId` not found or, `voteEnablerId` or `referenceId` not related to `voteId`
	NULL_ARGUMENT		`voteEnablerIds, voteId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.