OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.JobBatchAdminSession
Implementsosid.resourcing.JobAdminSession
Description

This session creates, updates, and deletes Jobs in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Job, a JobForm is requested using getJobFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned JobForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a JobForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each JobForm corresponds to an attempted transaction.

The JobForms returned from getJobFormsForCreate() may be linked to the originating request through the peer Ids of the JobForm. In the case where there may be duplicates, any JobForm of the same peer Ids may be used for a create operation.

Once a batch of JobForms are submitted for create, a CreateResponse is returned for each JobForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createJobs(), errors specific to an individual JobForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating JobForm through the JobForm Id .

For updates, JobForms are requested to the Job Id that is to be updated using getJobFormsForUpdate() where the reference Id in the JobForm may be used to link the request. Similarly, the JobForm has metadata about the data that can be updated and it can perform validation before submitting the update. The JobForm can only be used once for a successful update and cannot be reused.

Once a batch of JobForms are submitted for update, an UpdateResponse is returned for each JobForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateJobs(), errors specific to an individual JobForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating JobForm through the JobForm Id.

The delete operations delete Jobs in bulk. To unmap a Job from the current Foundry, the JobFoundryAssignmentSession should be used. These delete operations attempt to remove the Job itself thus removing it from all known Foundry catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetJobFormsForCreate
Description

Gets the job forms for creating a bunch of new jobs.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]jobRecordTypesarray of job record types to be included in each create operation or an empty list if none
Returnosid.resourcing.batch.JobBatchFormListthe job forms
ErrorsNULL_ARGUMENT jobRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateJobs
Description

Creates a new set of Jobs. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.resourcing.batch.JobBatchFormListjobFormsthe job forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT jobForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobFormsForUpdate
Description

Gets the job forms for updating an existing set of jobs. A new job form should be requested for each update transaction.

Parametersosid.id.IdListjobIdsthe Ids of the Job
Returnosid.resourcing.batch.JobBatchFormListthe job form
ErrorsNOT_FOUNDa jobId is not found
NULL_ARGUMENT jobIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateJobs
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 BatchCreateResponse .

Parametersosid.resourcing.batch.JobBatchFormListjobFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT jobForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllJobs
Description

Deletes all Jobs in this Foundry .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteJobs
Description

Deletes jobs for the given Ids.

Parametersosid.id.IdListjobIdsthe Ids of the jobs to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT jobIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasJobs
Description

Adds an Id to a Job for the purpose of creating compatibility. The primary Id of the Job is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another job, it is reassigned to the given job Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.