Interface | osid.hold.batch.IssueBatchAdminSession | ||
---|---|---|---|
Implements | osid.hold.IssueAdminSession | ||
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 | getIssueFormsForCreate | ||
Description |
Gets the issue forms for creating a bunch of new issues. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | issueRecordTypes | array of issue record types to be included in each create operation or an empty list if none | |
Return | osid.hold.batch.IssueBatchFormList | the issue forms | |
Errors | NULL_ARGUMENT | issueRecordTypes 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 | createIssues | ||
Description |
Creates a new set of | ||
Parameters | osid.hold.batch.IssueBatchFormList | issueForms | the issue forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | issueForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssueFormsForUpdate | ||
Description |
Gets the issue forms for updating an existing set of issues. A new issue form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | issueIds | the Ids of the Issue |
Return | osid.hold.batch.IssueBatchFormList | the issue form | |
Errors | NOT_FOUND | an issueId is not found | |
NULL_ARGUMENT | issueIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateIssues | ||
Description |
Updates existing issues. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.hold.batch.IssueBatchFormList | issueForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | issueForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllIssues | ||
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 | deleteIssues | ||
Description |
Deletes issues for the given | ||
Parameters | osid.id.IdList | issueIds | the Ids of the issues to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | issueIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIssuesByBureau | ||
Description |
Deletes issues for the given administrative organization. | ||
Parameters | osid.id.Id | resourceId | the Id 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 | aliasIssues | ||
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. |