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

Interface	osid.voting.rules.RaceProcessorRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods to apply `RaceProcessors` to `Races`.
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	canAssignRaceProcessors
Description	Tests if this user can alter race processor/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	assignRaceProcessorToRace
Description	Adds an existing `RaceProcessor` to a `Race`.
Parameters	`osid.id.Id`	`raceProcessorId`	the `Id` of the `RaceProcessor`
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race`
Errors	ALREADY_EXISTS		`raceProcessorId` is already applied to `raceId`
	NOT_FOUND		`raceProcessorId` or `raceId` not found
	NULL_ARGUMENT		`raceProcessorId` or `raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignRaceProcessorFromRace
Description	Removes a `RaceProcessor` from a `Race`.
Parameters	`osid.id.Id`	`raceProcessorId`	the `Id` of the `RaceProcessor`
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race`
Errors	NOT_FOUND		`raceProcessorId` or `raceId` not found or `raceProcessorId` not applied to `raceId`
	NULL_ARGUMENT		`raceProcessorId` or `raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceRaceProcessors
Description	Tests if this user can order `RaceProcessors`. 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 `RaceProcessor` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveRaceProcessorAhead
Description	Reorders race processors for a race by moving the specified race processor in front of a reference race processor.
Parameters	`osid.id.Id`	`raceProcessorId`	the `Id` of a `RaceProcessor`
	`osid.id.Id`	`raceId`	the `Id` of a `Race`
	`osid.id.Id`	`referenceId`	the reference race processor `Id`
Errors	NOT_FOUND		`raceProcessorId, raceId`, or `referenceId` not found or, `raceProcessorId` or `referenceId` not related to `raceId`
	NULL_ARGUMENT		`raceProcessorId, raceId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveRaceProcessorBehind
Description	Reorders race processors for a race by moving the specified race processor behind a reference race processor.
Parameters	`osid.id.Id`	`raceProcessorId`	the `Id` of a `RaceProcessor`
	`osid.id.Id`	`raceId`	the `Id` of a `Race`
	`osid.id.Id`	`referenceId`	the reference race processor `Id`
Errors	NOT_FOUND		`raceProcessorId, raceId`, or `referenceId` not found or, `raceProcessorId` or `referenceId` not related to `raceId`
	NULL_ARGUMENT		`raceProcessorId, raceId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderRaceProcessors
Description	Reorders a set of race processors for a race.
Parameters	`osid.id.Id[]`	`raceProcessorIds`	the `Ids` for a set of `RaceProcessors`
Parameters	`osid.id.Id`	`raceId`	the `Id` of a `Race`
Errors	NOT_FOUND		`raceId` not found or, a `raceProcessorId` not related to `raceProcessorId`
	NULL_ARGUMENT		`raceProcessorIds` or `raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.