Interface | osid.resourcing.batch.JobBatchAdminSession | ||
---|---|---|---|
Implements | osid.resourcing.JobAdminSession | ||
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 | getJobFormsForCreate | ||
Description |
Gets the job forms for creating a bunch of new jobs. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | jobRecordTypes | array of job record types to be included in each create operation or an empty list if none | |
Return | osid.resourcing.batch.JobBatchFormList | the job forms | |
Errors | NULL_ARGUMENT | jobRecordTypes 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 | createJobs | ||
Description |
Creates a new set of | ||
Parameters | osid.resourcing.batch.JobBatchFormList | jobForms | the job forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | jobForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobFormsForUpdate | ||
Description |
Gets the job forms for updating an existing set of jobs. A new job form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | jobIds | the Ids of the Job |
Return | osid.resourcing.batch.JobBatchFormList | the job form | |
Errors | NOT_FOUND | a jobId is not found | |
NULL_ARGUMENT | jobIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateJobs | ||
Description |
Updates existing jobs. This method returns an error if
the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.resourcing.batch.JobBatchFormList | jobForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | jobForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllJobs | ||
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 | deleteJobs | ||
Description |
Deletes jobs for the given | ||
Parameters | osid.id.IdList | jobIds | the Ids of the jobs to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | jobIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasJobs | ||
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. |