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

Interface	osid.voting.rules.RaceProcessorAdminSession
Implements	`osid.OsidSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session creates and removes race processors. The data for create and update is provided via the `RaceProcessorForm`.
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	canCreateRaceProcessor
Description	Tests if this user can create race processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `RaceProcessor` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `RaceProcessor` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRaceProcessorWithRecordTypes
Description	Tests if this user can create a single `RaceProcessor` using the desired record types. While `VotingRulesManager.getRaceProcessorRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `RaceProcessor`. Providing an empty array tests if a `RaceProcessor` can be created with no records.
Parameters	`osid.type.Type[]`	`raceProcessorRecordTypes`	array of race processor types
Return	`boolean`		`true` if `RaceProcessor` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`raceProcessorRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorFormForCreate
Description	Gets the race processor form for creating new race processors. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`raceProcessorRecordTypes`	array of race processor types
Return	`osid.voting.rules.RaceProcessorForm`		the race processor form
Errors	NULL_ARGUMENT		`raceProcessorRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createRaceProcessor
Description	Creates a new `RaceProcessor`.
Parameters	`osid.voting.rules.RaceProcessorForm`	`raceProcessorForm`	the form for this `RaceProcessor`
Return	`osid.voting.rules.RaceProcessor`		the new `RaceProcessor`
Errors	ILLEGAL_STATE		`raceProcessorForm` already used for a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`raceProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceProcessorForm did not originate from getRaceProcessorFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRaceProcessors
Description	Tests if this user can update race processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `RaceProcessor` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `RaceProcessor` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorFormForUpdate
Description	Gets the race processor form for updating an existing race processor. A new race processor form should be requested for each update transaction.
Parameters	`osid.id.Id`	`raceProcessorId`	the `Id` of the `RaceProcessor`
Return	`osid.voting.rules.RaceProcessorForm`		the race processor form
Errors	NOT_FOUND		`raceProcessorId` is not found
	NULL_ARGUMENT		`raceProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRaceProcessor
Description	Updates an existing race processor.
Parameters	`osid.voting.rules.RaceProcessorForm`	`raceProcessorForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`raceProcessorForm` already used for an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`raceProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceProcessorForm did not originate from getRaceProcessorFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRaceProcessors
Description	Tests if this user can delete race processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `RaceProcessor` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `RaceProcessor` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRaceProcessor
Description	Deletes a `RaceProcessor`.
Parameters	`osid.id.Id`	`raceProcessorId`	the `Id` of the `RaceProcessor` to remove
Errors	NOT_FOUND		`raceProcessorId` not found
	NULL_ARGUMENT		`raceProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRaceProcessorAliases
Description	Tests if this user can manage `Id` aliases for race processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `RaceProcessor` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRaceProcessor
Description	Adds a `Id` to a `RaceProcessor` for the purpose of creating compatibility. The primary `Id` of the `RaceProcessor` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another race processor. it is reassigned to the given race processor `Id`.
Parameters	`osid.id.Id`	`raceProcessorId`	the `Id` of a `RaceProcessor`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`raceProcessorId` not found
	NULL_ARGUMENT		`raceProcessorId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.