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

Interface	osid.voting.rules.RaceConstrainerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods to apply `RaceConstrainers` to `Races`. A `Race` with multiple `RaceConstrainers` means any positive rule evaluation across the constrainers result in an accessible `Race`.
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	canAssignRaceConstrainers
Description	Tests if this user can alter race constrainer/race 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	assignRaceConstrainerToRace
Description	Adds an existing `RaceConstrainer` to a `Race`.
Parameters	`osid.id.Id`	`raceConstrainerId`	the `Id` of the `RaceConstrainer`
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race`
Errors	ALREADY_EXISTS		`raceConstrainerId` is already applied to `raceId`
	NOT_FOUND		`raceConstrainerId` or `raceId` not found
	NULL_ARGUMENT		`raceConstrainerId` or `raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignRaceConstrainerFromRace
Description	Removes a `RaceConstrainer` from a `Race`.
Parameters	`osid.id.Id`	`raceConstrainerId`	the `Id` of the `RaceConstrainer`
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race`
Errors	NOT_FOUND		`raceConstrainerId` or `raceId` not found or `raceConstrainerId` not applied to `raceId`
	NULL_ARGUMENT		`raceConstrainerId` or `raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceRaceConstrainers
Description	Tests if this user can order `RaceConstrainers`. 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 `RaceConstrainer` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveRaceConstrainerAhead
Description	Reorders race constrainers for a race by moving the specified race constrainer in front of a reference race constrainer.
Parameters	`osid.id.Id`	`raceConstrainerId`	the `Id` of a `RaceConstrainer`
	`osid.id.Id`	`raceId`	the `Id` of a `Race`
	`osid.id.Id`	`referenceId`	the reference race constrainer `Id`
Errors	NOT_FOUND		`raceConstrainerId, raceId`, or `referenceId` not found or, `raceConstrainerId` or `referenceId` not related to `raceId`
	NULL_ARGUMENT		`raceConstrainerId, raceId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveRaceConstrainerBehind
Description	Reorders race constrainers for a race by moving the specified race constrainer behind a reference race constrainer.
Parameters	`osid.id.Id`	`raceConstrainerId`	the `Id` of a `RaceConstrainer`
	`osid.id.Id`	`raceId`	the `Id` of a `Race`
	`osid.id.Id`	`referenceId`	the reference race constrainer `Id`
Errors	NOT_FOUND		`raceConstrainerId, raceId`, or `referenceId` not found or, `raceConstrainerId` or `referenceId` not related to `raceId`
	NULL_ARGUMENT		`raceConstrainerId, raceId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderRaceConstrainers
Description	Reorders a set of race constrainers for a race.
Parameters	`osid.id.Id[]`	`raceConstrainerIds`	the `Ids` for a set of `RaceConstrainers`
Parameters	`osid.id.Id`	`raceId`	the `Id` of a `Race`
Errors	NOT_FOUND		`raceId` not found or, a `raceConstrainerId` not related to `raceId`
	NULL_ARGUMENT		`raceConstrainerIds` or `raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.