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

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