OSID - osid.voting.RaceAdminSession Service Interface Definition

Interface	osid.voting.RaceAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Races.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Race,` a `RaceForm` is requested using `getRaceFormForCreate()` specifying the `Ballot` and desired record `Types` or none if no record `Types` are needed. The returned `RaceForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `RaceForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RaceForm` corresponds to an attempted transaction. For updates, `RaceForms` are requested to the `Race` `Id` that is to be updated using `getRaceFormForUpdate().` Similarly, the `RaceForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RaceForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Races.` To unmap a `Race` from the current `Polls,` the `RacePollsAssignmentSession` should be used. These delete operations attempt to remove the `Race` itself thus removing it from all known `Polls` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRaces
Description	Tests if this user can create `Races` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Race` 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 `Race` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRaceWithRecordTypes
Description	Tests if this user can create a single `Race` using the desired record types. While `VotingManager.getRaceRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Race.` Providing an empty array tests if a `Race` can be created with no records.
Parameters	`osid.type.Type[]`	`raceRecordTypes`	array of race record types
Return	`boolean`		`true` if `Race` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`raceRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRaceFormForCreate
Description	Gets the race form for creating new races. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`ballotId`	a ballot `Id`
Parameters	`osid.type.Type[]`	`raceRecordTypes`	array of race record types
Return	`osid.voting.RaceForm`		the race form
Errors	NOT_FOUND		`raceId` is not found
	NULL_ARGUMENT		`raceId` or `raceRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form with requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createRace
Description	Creates a new `Race.`
Parameters	`osid.voting.RaceForm`	`raceForm`	the form for this `Race`
Return	`osid.voting.Race`		the new `Race`
Errors	ILLEGAL_STATE		`raceForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`raceForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceForm` did not originate from `getRaceFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRaces
Description	Tests if this user can update `Races.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Race` 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 `Race` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRaceFormForUpdate
Description	Gets the race form for updating an existing race. A new race form should be requested for each update transaction.
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race`
Return	`osid.voting.RaceForm`		the race form
Errors	NOT_FOUND		`raceId` is not found
	NULL_ARGUMENT		`raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRace
Description	Updates an existing race.
Parameters	`osid.voting.RaceForm`	`raceForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`raceForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceForm` did not originate from `getRaceFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRaces
Description	Tests if this user can delete `Races.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Race` 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 `Race` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRace
Description	Deletes a `Race.`
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race` to remove
Errors	NOT_FOUND		`raceId` is not found
	NULL_ARGUMENT		`raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRaceAliases
Description	Tests if this user can manage `Id` aliases for `Races.` 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 `Race` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRace
Description	Adds an `Id` to a `Race` for the purpose of creating compatibility. The primary `Id` of the `Race` 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, it is reassigned to the given race `Id.`
Parameters	`osid.id.Id`	`raceId`	the `Id` of a `Race`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`raceId` not found
	NULL_ARGUMENT		`raceId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.