Interface | osid.voting.batch.BallotBatchAdminSession | ||
---|---|---|---|
Implements | osid.voting.BallotAdminSession | ||
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 | getBallotFormsForCreate | ||
Description |
Gets the ballot forms for creating a bunch of new ballots. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | ballotRecordTypes | array of ballot record types to be included in each create operation or an empty list if none | |
Return | osid.voting.batch.BallotBatchFormList | the ballot forms | |
Errors | NULL_ARGUMENT | ballotRecordTypes 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 | createBallots | ||
Description |
Creates a new set of | ||
Parameters | osid.voting.batch.BallotBatchFormList | ballotForms | the ballot forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | ballotForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotFormsForUpdate | ||
Description |
Gets the ballot forms for updating an existing set of ballots. A new ballot form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | ballotIds | the Ids of the Ballot |
Return | osid.voting.batch.BallotBatchFormList | the ballot form | |
Errors | NOT_FOUND | a ballotId is not found | |
NULL_ARGUMENT | ballotIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateBallots | ||
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 | ||
Parameters | osid.voting.batch.BallotBatchFormList | ballotForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | ballotForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllBallots | ||
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 | deleteBallots | ||
Description |
Deletes ballots for the given | ||
Parameters | osid.id.IdList | ballotIds | the Ids of the ballots to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | ballotIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasBallots | ||
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. |