Interface | osid.tracking.batch.FrontOfficeBatchAdminSession | ||
---|---|---|---|
Implements | osid.tracking.FrontOfficeAdminSession | ||
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 | getFrontOfficeFormsForCreate | ||
Description |
Gets the front office forms for creating a bunch of new front offices. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | frontOfficeRecordTypes | array of front office record types to be included in each create operation or an empty list if none | |
Return | osid.tracking.batch.FrontOfficeBatchFormList | the front office forms | |
Errors | NULL_ARGUMENT | frontOfficeRecordTypes 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 | createFrontOffices | ||
Description |
Creates a new set of | ||
Parameters | osid.tracking.batch.FrontOfficeBatchFormList | frontOfficeForms | the front office forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | frontOfficeForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeFormsForUpdate | ||
Description |
Gets the front office forms for updating an existing set of front offices. A new front office form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | frontOfficeIds | the Ids of the FrontOffices |
Return | osid.tracking.batch.FrontOfficeBatchFormList | the front office forms | |
Errors | NOT_FOUND | a frontOfficeId is not found | |
NULL_ARGUMENT | frontOfficeIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateFrontOffices | ||
Description |
Updates existing front 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.tracking.batch.FrontOfficeBatchFormList | frontOfficeForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | frontOfficeForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllFrontOffices | ||
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 | deleteFrontOffices | ||
Description |
Deletes front offices for the given | ||
Parameters | osid.id.IdList | frontOfficeIds | the Ids of the front office to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | frontOfficeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasFrontOffices | ||
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. |