public interface CompetencyBatchAdminSession extends CompetencyAdminSession
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.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasCompetencies(AliasRequestList aliasRequests)
Adds an
Id to a Competency for the
purpose of creating compatibility. |
CreateResponseList |
createCompetencies(CompetencyBatchFormList competencyForms)
Creates a new set of
Competencies. |
DeleteResponseList |
deleteAllCompetencies()
Deletes all
Competencies in this Foundry
. |
DeleteResponseList |
deleteCompetencies(IdList competencyIds)
Deletes competencies for the given
Ids. |
CompetencyBatchFormList |
getCompetencyFormsForCreate(long number,
Type[] competencyRecordTypes)
Gets the competency forms for creating a bunch of new competencies.
|
CompetencyBatchFormList |
getCompetencyFormsForUpdate(IdList competencyIds)
Gets the competency forms for updating an existing set of
competencies.
|
UpdateResponseList |
updateCompetencies(CompetencyBatchFormList competencyForms)
Updates existing competencies.
|
aliasCompetency, canCreateCompetency, canCreateCompetencyWithRecordTypes, canDeleteCompetencies, canManageCompetencyAliases, canUpdateCompetencies, createCompetency, deleteCompetency, getCompetencyFormForCreate, getCompetencyFormForUpdate, getJob, getJobId, updateCompetency
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CompetencyBatchFormList getCompetencyFormsForCreate(long number, Type[] competencyRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievecompetencyRecordTypes
- array of competency record types to be
included in each create operation or an empty list if noneNullArgumentException
- competencyRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createCompetencies(CompetencyBatchFormList competencyForms) throws OperationFailedException, PermissionDeniedException
Competencies.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.competencyForms
- the competency formsNullArgumentException
- competencyForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompetencyBatchFormList getCompetencyFormsForUpdate(IdList competencyIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
competencyIds
- the Ids
of the Competency
NotFoundException
- a competencyId
is
not foundNullArgumentException
- competencyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateCompetencies(CompetencyBatchFormList competencyForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.competencyForms
- the form containing the elements to be updatedNullArgumentException
- competencyForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllCompetencies() throws OperationFailedException, PermissionDeniedException
Competencies
in this Foundry
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteCompetencies(IdList competencyIds) throws OperationFailedException, PermissionDeniedException
Ids.
competencyIds
- the Ids
of the competencies to
deleteNullArgumentException
- competencyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasCompetencies(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.