OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.CompetencyBatchAdminSession
Implementsosid.resourcing.CompetencyAdminSession
Description

This session creates, updates, and deletes Competencies 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 Competency, a CompetencyForm is requested using getCompetencyFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned CompetencyForms 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 CompetencyForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each CompetencyForm corresponds to an attempted transaction.

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

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

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

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

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

MethodgetCompetencyFormsForCreate
Description

Gets the competency forms for creating a bunch of new competencies.

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

Creates a new set of Competencies. 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.CompetencyBatchFormListcompetencyFormsthe competency forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT competencyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompetencyFormsForUpdate
Description

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

Parametersosid.id.IdListcompetencyIdsthe Ids of the Competency
Returnosid.resourcing.batch.CompetencyBatchFormListthe competency form
ErrorsNOT_FOUNDa competencyId is not found
NULL_ARGUMENT competencyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCompetencies
Description

Updates existing competencies. 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.CompetencyBatchFormListcompetencyFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT competencyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllCompetencies
Description

Deletes all Competencies in this Foundry .

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

Deletes competencies for the given Ids.

Parametersosid.id.IdListcompetencyIdsthe Ids of the competencies to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT competencyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasCompetencies
Description

Adds an Id to a Competency for the purpose of creating compatibility. The primary Id of the Competency is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another competency, it is reassigned to the given competency 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.