OSID Logo
OSID Specifications
voting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.batch.PollsBatchAdminSession
Implementsosid.voting.PollsAdminSession
Description

This session creates, updates, and deletes Polls 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 an Polls, an PollsForm is requested using getPollsFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned PollsForms 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 an PollsForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each PollsForm corresponds to an attempted transaction.

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

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

For updates, PollsForms are requested to the Polls Id that is to be updated using getPollsFormsForUpdate() where the reference Id in the PollsForm may be used to link the request. Similarly, the PollsForm has metadata about the data that can be updated and it can perform validation before submitting the update. The PollsForm can only be used once for a successful update and cannot be reused.

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

The delete operations delete Polls in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetPollsFormsForCreate
Description

Gets the polls forms for creating a bunch of new polls.

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

Creates a new set of Polls. 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.PollsBatchFormListpollsFormsthe polls forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT pollsForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPollsFormsForUpdate
Description

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

Parametersosid.id.IdListpollsIdsthe Ids of the Polls
Returnosid.voting.batch.PollsBatchFormListthe polls form
ErrorsNOT_FOUNDan pollsId is not found
NULL_ARGUMENT pollsIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePolls
Description

Updates existing polls. 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.PollsBatchFormListpollsFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT pollsForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllPolls
Description

Deletes all Polls.

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

Deletes polls for the given Ids.

Parametersosid.id.IdListpollsIdsthe Ids of the polls to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT pollsIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasPolls
Description

Adds an Id to an Polls for the purpose of creating compatibility. The primary Id of the Polls is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another polls, it is reassigned to the given polls 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.