OSID - osid.voting.batch.VotingBatchSession Service Interface Definition

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. `OsidForms` are requested for eachupdate and may not be reused. Create and update operations differ in their usage. To create a `Vote,` a `VoteForm` is requested using `getVoteForms()` specifying the desired race, candidate, and record `Types` or none if no record `Types` are needed. Each of the returned `VoteForms` 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 `VoteForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `VoteForm` corresponds to an attempted transaction. The `VoteForms` returned from `getVoteForms()` may be linked to the originating request through the peer `Ids` of the `VoteForm.` In the case where there may be duplicates, any `VoteForm` of the same peer `Ids` may be used for a create operation. Once a batch of `VoteForms` are submitted for create, a `CreateResponse` is returned for each `VoteForm,` although the ordering is not defined. Only errors that pertain to the entire create operation are returned from `castVotes()` errors specific to an individual `VoteForm` are indicated in the corresponding `CreateResponse.` `CreateResponses` may be linked to the originating `VoteForm` through the `VoteForm` `Id` . The delete operations delete `Votes` in bulk. Bulk delete operations return the results in `DeleteResponses.`
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
Parameters	`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 `Votes.` This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the `BatchCreateResponse` .
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 `Votes` in this `Polls` .
Return	`osid.transaction.batch.DeleteResponseList`		the delete responses
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	deleteVotes
Description	Deletes votes for the given `Ids.`
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 `Id` to a `Vote` for the purpose of creating compatibility. The primary `Id` of the `Vote` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another vote, it is reassigned to the given vote `Id.`
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.