Interface | osid.workflow.batch.WorkBatchAdminSession | ||
---|---|---|---|
Implements | osid.workflow.WorkAdminSession | ||
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 | getWorkFormsForCreate | ||
Description |
Gets the work forms for creating a bunch of new works. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | workRecordTypes | array of work record types to be included in each create operation or an empty list if none | |
Return | osid.workflow.batch.WorkBatchFormList | the work forms | |
Errors | NULL_ARGUMENT | workRecordTypes 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 | createWorks | ||
Description |
Creates a new set of | ||
Parameters | osid.workflow.batch.WorkBatchFormList | workForms | the work forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | workForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorkFormsForUpdate | ||
Description |
Gets the work forms for updating an existing set of works. A new work form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | workIds | the Ids of the Work |
Return | osid.workflow.batch.WorkBatchFormList | the work form | |
Errors | NOT_FOUND | a workId is not found | |
NULL_ARGUMENT | workIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateWorks | ||
Description |
Updates existing works. This method returns an error if
the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.workflow.batch.WorkBatchFormList | workForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | workForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllWorks | ||
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 | deleteWorks | ||
Description |
Deletes works for the given | ||
Parameters | osid.id.IdList | workIds | the Ids of the works to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | workIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasWorks | ||
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. |