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

Interface	osid.voting.rules.BallotConstrainerEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods to apply `BallotConstrainerEnablers` to `BallotConstrainers`. A `BallotConstrainer` with multiple `BallotConstrainerEnablers` means any positive rule evaluation across the enablers result in an effective `BallotConstrainer`.
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	canAssignBallotConstrainerEnablers
Description	Tests if this user can alter ballot constrainer enabler/ballot constrainer 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	assignBallotConstrainerEnablerToBallotConstrainer
Description	Adds an existing `BallotConstrainerEnabler` to a `BallotConstrainer`.
Parameters	`osid.id.Id`	`ballotConstrainerEnablerId`	the `Id` of the `BallotConstrainerEnabler`
Parameters	`osid.id.Id`	`ballotConstrainerId`	the `Id` of the `BallotConstrainer`
Errors	ALREADY_EXISTS		`ballotConstrainerEnablerId` is already applied to `ballotConstrainerId`
	NOT_FOUND		`ballotConstrainerEnablerId` or `ballotConstrainerId` not found
	NULL_ARGUMENT		`ballotConstrainerEnablerId` or `ballotConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignBallotConstrainerEnablerFromBallotConstrainer
Description	Removes a `BallotConstrainerEnabler` from a `BallotConstrainer`.
Parameters	`osid.id.Id`	`ballotConstrainerEnablerId`	the `Id` of the `BallotConstrainerEnabler`
Parameters	`osid.id.Id`	`ballotConstrainerId`	the `Id` of the `BallotConstrainer`
Errors	NOT_FOUND		`ballotConstrainerEnablerId` or `ballotConstrainerId` not found or `ballotConstrainerEnablerId` not applied to `ballotConstrainerId`
	NULL_ARGUMENT		`ballotConstrainerEnablerId` or `ballotConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceBallotConstrainerEnablers
Description	Tests if this user can order `BallotConstrainerEnablers`. 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 `BallotConstrainerEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveBallotConstrainerEnablerAhead
Description	Reorders ballot constrainer enablers for a ballot constrainer by moving the specified ballot constrainer enabler in front of a reference ballot constrainer enabler.
Parameters	`osid.id.Id`	`ballotConstrainerEnablerId`	the `Id` of a `BallotConstrainerEnabler`
	`osid.id.Id`	`ballotConstrainerId`	the `Id` of a `BallotConstrainer`
	`osid.id.Id`	`referenceId`	the reference ballot constrainer enabler `Id`
Errors	NOT_FOUND		`ballotConstrainerEnablerId, ballotConstrainerId`, or `referenceId` not found or, `ballotConstrainerId` or `referenceId` not related to `ballotConstrainerId`
	NULL_ARGUMENT		`ballotConstrainerEnablerId, ballotConstrainerId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveBallotConstrainerEnablerBehind
Description	Reorders ballot constrainer enablers for a ballot constrainer by moving the specified ballot constrainer enabler behind a reference ballot constrainer enabler.
Parameters	`osid.id.Id`	`ballotConstrainerEnablerId`	the `Id` of a `BallotConstrainerEnabler`
	`osid.id.Id`	`ballotConstrainerId`	the `Id` of a `BallotConstrainer`
	`osid.id.Id`	`referenceId`	the reference ballot constrainer enabler `Id`
Errors	NOT_FOUND		`ballotConstrainerEnablerId, ballotConstrainerId`, or `referenceId` not found or, `ballotConstrainerId` or `referenceId` not related to `ballotConstrainerId`
	NULL_ARGUMENT		`ballotConstrainerEnablerId, ballotConstrainerId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderBallotConstrainerEnablers
Description	Reorders a set of ballot constrainer enablers for a ballot constrainer.
Parameters	`osid.id.Id[]`	`ballotConstrainerEnablerIds`	the `Ids` for a set of `BallotConstrainerEnablers`
Parameters	`osid.id.Id`	`ballotConstrainerId`	the `Id` of a `BallotConstrainer`
Errors	NOT_FOUND		`ballotConstrainerId` not found or, a `ballotConstrainerEnablerId` not related to `ballotConstrainerId`
	NULL_ARGUMENT		`ballotConstrainerEnablerIds` or `ballotConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.