Interface | osid.recipe.batch.ProcedureBatchAdminSession | ||
---|---|---|---|
Implements | osid.recipe.ProcedureAdminSession | ||
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 | getProcedureFormsForCreate | ||
Description |
Gets the procedure forms for creating a bunch of new procedures. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | procedureRecordTypes | array of procedure record types to be included in each create operation or an empty list if none | |
Return | osid.recipe.batch.ProcedureBatchFormList | the procedure forms | |
Errors | NULL_ARGUMENT | procedureRecordTypes 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 | createProcedures | ||
Description |
Creates a new set of | ||
Parameters | osid.recipe.batch.ProcedureBatchFormList | procedureForms | the procedure forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | procedureForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProcedureFormsForUpdate | ||
Description |
Gets the procedure forms for updating an existing set of procedures. A new procedure form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | procedureIds | the Ids of the Procedure |
Return | osid.recipe.batch.ProcedureBatchFormList | the procedure form | |
Errors | NOT_FOUND | a procedureId is not found | |
NULL_ARGUMENT | procedureIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProcedures | ||
Description |
Updates existing procedures. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.recipe.batch.ProcedureBatchFormList | procedureForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | procedureForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllProcedures | ||
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 | deleteProcedures | ||
Description |
Deletes procedures for the given | ||
Parameters | osid.id.IdList | procedureIds | the Ids of the procedures to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | procedureIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasProcedures | ||
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. |