Interface | osid.voting.batch.PollsBatchAdminSession | ||
---|---|---|---|
Implements | osid.voting.PollsAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getPollsFormsForCreate | ||
Description |
Gets the polls forms for creating a bunch of new polls. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | pollsRecordTypes | array of polls record types to be included in each create operation or an empty list if none | |
Return | osid.voting.batch.PollsBatchFormList | the polls forms | |
Errors | NULL_ARGUMENT | pollsRecordTypes 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 | createPolls | ||
Description |
Creates a new set of | ||
Parameters | osid.voting.batch.PollsBatchFormList | pollsForms | the polls forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | pollsForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPollsFormsForUpdate | ||
Description |
Gets the polls forms for updating an existing set of polls. A new polls form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | pollsIds | the Ids of the Polls |
Return | osid.voting.batch.PollsBatchFormList | the polls form | |
Errors | NOT_FOUND | an pollsId is not found | |
NULL_ARGUMENT | pollsIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePolls | ||
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 | ||
Parameters | osid.voting.batch.PollsBatchFormList | pollsForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | pollsForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllPolls | ||
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 | deletePolls | ||
Description |
Deletes polls for the given | ||
Parameters | osid.id.IdList | pollsIds | the Ids of the polls to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | pollsIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasPolls | ||
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. |