public interface CompositionBatchAdminSession extends CompositionAdminSession
This session creates, updates, and deletes Compositions
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
Composition,
a CompositionForm
is requested using
getCompositionFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned CompositionForms
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 CompositionForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
CompositionForm
corresponds to an attempted transaction.
The CompositionForms
returned from
getCompositionFormsForCreate()
may be linked to the originating
request through the peer Ids
of the CompositionForm.
In the case where there may be duplicates, any
CompositionForm
of the same peer Ids
may be used
for a create operation.
Once a batch of CompositionForms
are submitted for
create, a CreateResponse
is returned for each
CompositionForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createCompositions(),
errors specific to an individual
CompositionForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating CompositionForm
through the
CompositionForm
Id
.
For updates, CompositionForms
are requested to the
Composition
Id
that is to be updated using
getCompositionFormsForUpdate()
where the reference
Id
in the CompositionForm
may be used to link the
request. Similarly, the CompositionForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The CompositionForm
can only be used
once for a successful update and cannot be reused.
Once a batch of CompositionForms
are submitted for
update, an UpdateResponse
is returned for each
CompositionForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateCompositions(),
errors specific to an individual
CompositionForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating CompositionForm
through the
CompositionForm
Id.
The delete operations delete Compositions
in bulk. To
unmap a Composition
from the current Repository,
the CompositionRepositoryAssignmentSession
should
be used. These delete operations attempt to remove the Composition
itself thus removing it from all known Repository
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasCompositions(AliasRequestList aliasRequests)
Adds an
Id to a Composition for the
purpose of creating compatibility. |
CreateResponseList |
createCompositions(CompositionBatchFormList compositionForms)
Creates a new set of
Compositions. |
DeleteResponseList |
deleteAllCompositions()
Deletes all
Compositions in this Repository
. |
DeleteResponseList |
deleteCompositions(IdList compositionIds)
Deletes compositions for the given
Ids. |
DeleteResponseList |
deleteIneffectiveCompositionsByDate(DateTime date)
Deletes compositions expired before the given date.
|
CompositionBatchFormList |
getCompositionFormsForCreate(long number,
Type[] compositionRecordTypes)
Gets the composition forms for creating a bunch of new compositions.
|
CompositionBatchFormList |
getCompositionFormsForUpdate(IdList compositionIds)
Gets the composition forms for updating an existing set of
compositions.
|
UpdateResponseList |
updateCompositions(CompositionBatchFormList compositionForms)
Updates existing compositions.
|
addCompositionChild, aliasComposition, canCreateCompositions, canCreateCompositionWithRecordTypes, canDeleteCompositions, canManageCompositionAliases, canUpdateCompositions, createComposition, deleteComposition, deleteCompositionNode, getCompositionFormForCreate, getCompositionFormForUpdate, getRepository, getRepositoryId, removeCompositionChild, updateComposition
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CompositionBatchFormList getCompositionFormsForCreate(long number, Type[] compositionRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievecompositionRecordTypes
- array of composition record types to be
included in each create operation or an empty list if noneNullArgumentException
- compositionRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createCompositions(CompositionBatchFormList compositionForms) throws OperationFailedException, PermissionDeniedException
Compositions.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.compositionForms
- the composition formsNullArgumentException
- compositionForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CompositionBatchFormList getCompositionFormsForUpdate(IdList compositionIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
compositionIds
- the Ids
of the
Composition
NotFoundException
- a compositionId
is
not foundNullArgumentException
- compositionIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateCompositions(CompositionBatchFormList compositionForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.compositionForms
- the form containing the elements to be
updatedNullArgumentException
- compositionForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllCompositions() throws OperationFailedException, PermissionDeniedException
Compositions
in this Repository
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteCompositions(IdList compositionIds) throws OperationFailedException, PermissionDeniedException
Ids.
compositionIds
- the Ids
of the compositions to
deleteNullArgumentException
- compositionIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveCompositionsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasCompositions(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Composition
for the
purpose of creating compatibility. The primary Id
of
the Composition
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another composition, it is reassigned to the
given composition Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.