public interface BallotBatchAdminSession extends BallotAdminSession
This session creates, updates, and deletes Ballots
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
Ballot,
a BallotForm
is requested using
getBallotFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed. Each
of the returned BallotForms
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 BallotForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
BallotForm
corresponds to an attempted transaction.
The BallotForms
returned from
getBallotFormsForCreate()
may be linked to the originating request
through the peer Ids
of the BallotForm.
In
the case where there may be duplicates, any BallotForm
of
the same peer Ids
may be used for a create operation.
Once a batch of BallotForms
are submitted for create, a
CreateResponse
is returned for each BallotForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createBallots(),
errors specific to an individual BallotForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating BallotForm
through the BallotForm
Id
.
For updates, BallotForms
are requested to the
Ballot
Id
that is to be updated using
getBallotFormsForUpdate()
where the reference Id
in
the BallotForm
may be used to link the request. Similarly,
the BallotForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
BallotForm
can only be used once for a successful update
and cannot be reused.
Once a batch of BallotForms
are submitted for update,
an UpdateResponse
is returned for each BallotForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateBallots(),
errors specific to an individual BallotForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating BallotForm
through the BallotForm
Id.
The delete operations delete Ballots
in bulk. To unmap
a Ballot
from the current Polls,
the
BallotPollsAssignmentSession
should be used. These delete
operations attempt to remove the Ballot
itself thus
removing it from all known Polls
catalogs. Bulk delete
operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasBallots(AliasRequestList aliasRequests)
Adds an
Id to a Ballot for the purpose
of creating compatibility. |
CreateResponseList |
createBallots(BallotBatchFormList ballotForms)
Creates a new set of
Ballots. |
DeleteResponseList |
deleteAllBallots()
Deletes all
Ballots in this Polls . |
DeleteResponseList |
deleteBallots(IdList ballotIds)
Deletes ballots for the given
Ids. |
BallotBatchFormList |
getBallotFormsForCreate(long number,
Type[] ballotRecordTypes)
Gets the ballot forms for creating a bunch of new ballots.
|
BallotBatchFormList |
getBallotFormsForUpdate(IdList ballotIds)
Gets the ballot forms for updating an existing set of ballots.
|
UpdateResponseList |
updateBallots(BallotBatchFormList ballotForms)
Updates existing ballots.
|
aliasBallot, canCreateBallots, canCreateBallotWithRecordTypes, canDeleteBallots, canManageBallotAliases, canUpdateBallots, createBallot, deleteBallot, getBallotFormForCreate, getBallotFormForUpdate, getPolls, getPollsId, updateBallot
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BallotBatchFormList getBallotFormsForCreate(long number, Type[] ballotRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveballotRecordTypes
- array of ballot record types to be included
in each create operation or an empty list if noneNullArgumentException
- ballotRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createBallots(BallotBatchFormList ballotForms) throws OperationFailedException, PermissionDeniedException
Ballots.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.ballotForms
- the ballot formsNullArgumentException
- ballotForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BallotBatchFormList getBallotFormsForUpdate(IdList ballotIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ballotIds
- the Ids
of the Ballot
NotFoundException
- a ballotId
is not
foundNullArgumentException
- ballotIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateBallots(BallotBatchFormList ballotForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.ballotForms
- the form containing the elements to be updatedNullArgumentException
- ballotForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllBallots() throws OperationFailedException, PermissionDeniedException
Ballots
in this Polls
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBallots(IdList ballotIds) throws OperationFailedException, PermissionDeniedException
Ids.
ballotIds
- the Ids
of the ballots to deleteNullArgumentException
- ballotIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasBallots(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Ballot
for the purpose
of creating compatibility. The primary Id
of the
Ballot
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another ballot, it is reassigned to the given ballot
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.