OSID Logo
OSID Specifications
voting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.batch.BallotBatchAdminSession
Implementsosid.voting.BallotAdminSession
Description

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.

MethodgetBallotFormsForCreate
Description

Gets the ballot forms for creating a bunch of new ballots.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]ballotRecordTypesarray of ballot record types to be included in each create operation or an empty list if none
Returnosid.voting.batch.BallotBatchFormListthe ballot forms
ErrorsNULL_ARGUMENT ballotRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateBallots
Description

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

Parametersosid.voting.batch.BallotBatchFormListballotFormsthe ballot forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT ballotForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBallotFormsForUpdate
Description

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

Parametersosid.id.IdListballotIdsthe Ids of the Ballot
Returnosid.voting.batch.BallotBatchFormListthe ballot form
ErrorsNOT_FOUNDa ballotId is not found
NULL_ARGUMENT ballotIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBallots
Description

Updates existing ballots. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.voting.batch.BallotBatchFormListballotFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT ballotForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllBallots
Description

Deletes all Ballots in this Polls .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteBallots
Description

Deletes ballots for the given Ids.

Parametersosid.id.IdListballotIdsthe Ids of the ballots to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT ballotIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasBallots
Description

Adds an 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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.