Interface | osid.voting.batch.RaceBatchAdminSession | ||
---|---|---|---|
Implements | osid.voting.RaceAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getRaceFormsForCreate | ||
Description |
Gets the race forms for creating a bunch of new races.
A RaceForm is returned for each ballot | ||
Parameters | osid.id.IdList | ballotIds | an Id of a ballot |
osid.type.Type[] | raceRecordTypes | array of race record types to be included in each create operation or an empty list if none | |
Return | osid.voting.batch.RaceBatchFormList | the race forms | |
Errors | NOT_FOUND | a ballotId is not found | |
NULL_ARGUMENT | ballotId or raceRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createRaces | ||
Description |
Creates a new set of | ||
Parameters | osid.voting.batch.RaceBatchFormList | raceForms | the race forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | raceForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRaceFormsForUpdate | ||
Description |
Gets the race forms for updating an existing set of races. A new race form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | raceIds | the Ids of the Race |
Return | osid.voting.batch.RaceBatchFormList | the race form | |
Errors | NOT_FOUND | a raceId is not found | |
NULL_ARGUMENT | raceIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRaces | ||
Description |
Updates existing races. This method returns an error if
the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.voting.batch.RaceBatchFormList | raceForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | raceForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllRaces | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRaces | ||
Description |
Deletes races for the given | ||
Parameters | osid.id.IdList | raceIds | the Ids of the races to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | raceIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRacesForBallot | ||
Description |
Deletes all races for the given ballot. | ||
Parameters | osid.id.Id | ballotId | an Id of a ballot |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | ballotId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasRaces | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |