Interface | osid.voting.batch.VotingBatchSession | ||
---|---|---|---|
Implements | osid.voting.VotingSession | ||
Description |
This session votes in bulk. The data for create and update
is provided by the consumer via the form object. Create and update operations differ in their usage. To
create a The Once a batch of The delete operations delete | ||
Method | getVoteForms | ||
Description |
Gets the vote forms for casting a bunch of new votes. A vote form is returned for each supplied race and candidate pair. | ||
Parameters | osid.voting.batch.VotePeerList | peers | the vote peers |
osid.type.Type[] | voteRecordTypes | array of vote record types to be included in each create operation or an empty list if none | |
Return | osid.voting.batch.VoteBatchFormList | the vote forms | |
Errors | NOT_FOUND | a raceId or candidateId is not found | |
NULL_ARGUMENT | peers or voteRecordTypes 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 | castVotes | ||
Description |
Creates a new set of | ||
Parameters | osid.voting.batch.VoteBatchFormList | voteForms | the vote forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | voteForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllVotes | ||
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 | deleteVotes | ||
Description |
Deletes votes for the given | ||
Parameters | osid.id.IdList | voteIds | the Ids of the votes to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | voteIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteVotesForRace | ||
Description |
Deletes votes for the given race. | ||
Parameters | osid.id.Id | raceId | the Ids of a race |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | raceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteVotesForVoter | ||
Description |
Deletes votes cast by a voter. | ||
Parameters | osid.id.Id | resourceId | the Ids of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteVotesForBallot | ||
Description |
Deletes all votes for all races on a ballot. | ||
Parameters | osid.id.Id | ballotId | the Ids of a ballot |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | ballotId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveVotesByDate | ||
Description |
Deletes votes ineffective before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasVotes | ||
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. |