org.osid.voting.batch

Interface RaceBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, RaceAdminSession

public interface RaceBatchAdminSession
extends RaceAdminSession

This session creates, updates, and deletes Races in bulk. 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 getRaceFormsForCreate() specifying the ballot and desired record Types or none if no record Types are needed. Each of the returned RaceForms 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 a 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.

The RaceForms returned from getRaceFormsForCreate() may be linked to the originating request through the peer Ids of the RaceForm. In the case where there may be duplicates, any RaceForm of the same peer Ids may be used for a create operation.

Once a batch of RaceForms are submitted for create, a CreateResponse is returned for each RaceForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createRaces(), errors specific to an individual RaceForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating RaceForm through the RaceForm Id .

For updates, RaceForms are requested to the Race Id that is to be updated using getRaceFormsForUpdate() where the reference Id in the RaceForm may be used to link the request. 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.

Once a batch of RaceForms are submitted for update, an UpdateResponse is returned for each RaceForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateRaces(), errors specific to an individual RaceForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating RaceForm through the RaceForm Id.

The delete operations delete Races in bulk. 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. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasRaces(AliasRequestList aliasRequests) Adds an Id to a Race for the purpose of creating compatibility.
CreateResponseList	createRaces(RaceBatchFormList raceForms) Creates a new set of Races.
DeleteResponseList	deleteAllRaces() Deletes all Races in this Polls .
DeleteResponseList	deleteRaces(IdList raceIds) Deletes races for the given Ids.
DeleteResponseList	deleteRacesForBallot(Id ballotId) Deletes all races for the given ballot.
RaceBatchFormList	getRaceFormsForCreate(IdList ballotIds, Type[] raceRecordTypes) Gets the race forms for creating a bunch of new races.
RaceBatchFormList	getRaceFormsForUpdate(IdList raceIds) Gets the race forms for updating an existing set of races.
UpdateResponseList	updateRaces(RaceBatchFormList raceForms) Updates existing races.

Methods inherited from interface org.osid.voting.RaceAdminSession

aliasRace, canCreateRaces, canCreateRaceWithRecordTypes, canDeleteRaces, canManageRaceAliases, canUpdateRaces, createRace, deleteRace, getPolls, getPollsId, getRaceFormForCreate, getRaceFormForUpdate, updateRace

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getRaceFormsForCreate

RaceBatchFormList getRaceFormsForCreate(IdList ballotIds,
                                      Type[] raceRecordTypes)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the race forms for creating a bunch of new races. A RaceForm is returned for each ballot Id.

Parameters:

ballotIds - an Id of a ballot

raceRecordTypes - array of race record types to be included in each create operation or an empty list if none

Returns:

the race forms

Throws:

NotFoundException - a ballotId is not found

NullArgumentException - ballotId or raceRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createRaces

CreateResponseList createRaces(RaceBatchFormList raceForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

Creates a new set of Races. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

raceForms - the race forms

Returns:

the create responses

Throws:

NullArgumentException - raceForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRaceFormsForUpdate

RaceBatchFormList getRaceFormsForUpdate(IdList raceIds)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the race forms for updating an existing set of races. A new race form should be requested for each update transaction.

Parameters:

raceIds - the Ids of the Race

Returns:

the race form

Throws:

NotFoundException - a raceId is not found

NullArgumentException - raceIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRaces

UpdateResponseList updateRaces(RaceBatchFormList raceForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 BatchCreateResponse .

Parameters:

raceForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - raceForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllRaces

DeleteResponseList deleteAllRaces()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes all Races in this Polls .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRaces

DeleteResponseList deleteRaces(IdList raceIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Deletes races for the given Ids.

Parameters:

raceIds - the Ids of the races to delete

Returns:

the delete responses

Throws:

NullArgumentException - raceIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRacesForBallot

DeleteResponseList deleteRacesForBallot(Id ballotId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes all races for the given ballot.

Parameters:

ballotId - an Id of a ballot

Returns:

the delete responses

Throws:

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasRaces

AliasResponseList aliasRaces(AliasRequestList aliasRequests)
                             throws OperationFailedException,
                                    PermissionDeniedException

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 is an alias to the primary Id. If the alias is a pointer to another race, it is reassigned to the given race Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.