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

Interface	osid.voting.rules.RaceProcessorEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session creates and removes race processor enablers. The data for create and update is provided via the `RaceProcessorEnablerForm`.
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	canCreateRaceProcessorEnabler
Description	Tests if this user can create race processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `RaceProcessorEnabler` 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 `RaceProcessorEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRaceProcessorEnablerWithRecordTypes
Description	Tests if this user can create a single `RaceProcessorEnabler` using the desired record types. While `VotingRulesManager.getRaceProcessorEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `RaceProcessorEnabler`. Providing an empty array tests if a `RaceProcessorEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`raceProcessorEnablerRecordTypes`	array of race processor enabler record types
Return	`boolean`		`true` if `RaceProcessorEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`raceProcessorEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablerFormForCreate
Description	Gets the race processor enabler form for creating new race processor enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`raceProcessorEnablerRecordTypes`	array of race processor enabler record types
Return	`osid.voting.rules.RaceProcessorEnablerForm`		the race processor enabler form
Errors	NULL_ARGUMENT		`raceProcessorEnablerRecordTypes` 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	createRaceProcessorEnabler
Description	Creates a new `RaceProcessorEnabler`.
Parameters	`osid.voting.rules.RaceProcessorEnablerForm`	`raceProcessorEnablerForm`	the form for this `RaceProcessorEnabler`
Return	`osid.voting.rules.RaceProcessorEnabler`		the new `RaceProcessorEnabler`
Errors	ILLEGAL_STATE		`raceProcessorEnablerForm` already used for a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`raceProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceProcessorEnablerForm did not originate from getRaceProcessorrEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRaceProcessorEnablers
Description	Tests if this user can update race processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `RaceProcessorEnabler` 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 `RaceProcessorEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablerFormForUpdate
Description	Gets the race processor enabler form for updating an existing race processor enabler. A new race processor enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`raceProcessorEnablerId`	the `Id` of the `RaceProcessorEnabler`
Return	`osid.voting.rules.RaceProcessorEnablerForm`		the race processor enabler form
Errors	NOT_FOUND		`raceProcessorEnablerId` is not found
	NULL_ARGUMENT		`raceProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRaceProcessorEnabler
Description	Updates an existing race processor enabler.
Parameters	`osid.voting.rules.RaceProcessorEnablerForm`	`raceProcessorEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`raceProcessorEnablerForm` already used for an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`raceProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceProcessorEnablerForm did not originate from getRaceProcessorrEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRaceProcessorEnablers
Description	Tests if this user can delete race processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `RaceProcessorEnabler` 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 `RaceProcessorEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRaceProcessorEnabler
Description	Deletes a `RaceProcessorEnabler`.
Parameters	`osid.id.Id`	`raceProcessorEnablerId`	the `Id` of the `RaceProcessorEnabler` to remove
Errors	NOT_FOUND		`raceProcessorEnablerId` not found
	NULL_ARGUMENT		`raceProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRaceProcessorEnablerAliases
Description	Tests if this user can manage `Id` aliases for race processor enablers. 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 `RaceProcessorEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRaceProcessorEnabler
Description	Adds a `Id` to a `RaceProcessorEnabler` for the purpose of creating compatibility. The primary `Id` of the `RaceProcessorEnabler` 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 enabler. it is reassigned to the given race processor enabler `Id`.
Parameters	`osid.id.Id`	`raceProcessorEnablerId`	the `Id` of a `RaceProcessorEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`raceProcessorEnablerId` not found
	NULL_ARGUMENT		`raceProcessorEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.