Interface | osid.workflow.batch.OfficeBatchAdminSession | ||
---|---|---|---|
Implements | osid.workflow.OfficeAdminSession | ||
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 | getOfficeFormsForCreate | ||
Description |
Gets the office forms for creating a bunch of new offices. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | officeRecordTypes | array of office record types to be included in each create operation or an empty list if none | |
Return | osid.workflow.batch.OfficeBatchFormList | the office forms | |
Errors | NULL_ARGUMENT | officeRecordTypes 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 | createOffices | ||
Description |
Creates a new set of | ||
Parameters | osid.workflow.batch.OfficeBatchFormList | officeForms | the office forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | officeForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOfficeFormsForUpdate | ||
Description |
Gets the office forms for updating an existing set of offices. A new office form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | officeIds | the Ids of the Office |
Return | osid.workflow.batch.OfficeBatchFormList | the office form | |
Errors | NOT_FOUND | an officeId is not found | |
NULL_ARGUMENT | officeIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateOffices | ||
Description |
Updates existing offices. 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.OfficeBatchFormList | officeForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | officeForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllOffices | ||
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 | deleteOffices | ||
Description |
Deletes offices for the given | ||
Parameters | osid.id.IdList | officeIds | the Ids of the offices to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | officeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasOffices | ||
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. |