public interface RepositoryBatchAdminSession extends RepositoryAdminSession
This session creates, updates, and deletes Repositories
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 an
Repository,
an RepositoryForm
is requested
using getRepositoryFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned RepositoryForms
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 an RepositoryForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
RepositoryForm
corresponds to an attempted transaction.
The RepositoryForms
returned from
getRepositoryFormsForCreate()
may be linked to the originating
request through the peer Ids
of the RepositoryForm.
In the case where there may be duplicates, any
RepositoryForm
of the same peer Ids
may be used for
a create operation.
Once a batch of RepositoryForms
are submitted for
create, a CreateResponse
is returned for each
RepositoryForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createRepositories(),
errors specific to an individual
RepositoryForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating RepositoryForm
through the
RepositoryForm
Id
.
For updates, RepositoryForms
are requested to the
Repository
Id
that is to be updated using
getRepositoryFormsForUpdate()
where the reference Id
in the RepositoryForm
may be used to link the
request. Similarly, the RepositoryForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The RepositoryForm
can only be used
once for a successful update and cannot be reused.
Once a batch of RepositoryForms
are submitted for
update, an UpdateResponse
is returned for each
RepositoryForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateRepositories(),
errors specific to an individual
RepositoryForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating RepositoryForm
through the
RepositoryForm
Id.
The delete operations delete Repositories
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasRepositories(AliasRequestList aliasRequests)
Adds an
Id to an Repository for the
purpose of creating compatibility. |
CreateResponseList |
createRepositories(RepositoryBatchFormList repositoryForms)
Creates a new set of
Repositories. |
DeleteResponseList |
deleteAllRepositories()
Deletes all
Repositories. |
DeleteResponseList |
deleteRepositories(IdList repositoryIds)
Deletes repositories for the given
Ids. |
RepositoryBatchFormList |
getRepositoryFormsForCreate(long number,
Type[] repositoryRecordTypes)
Gets the repository forms for creating a bunch of new repositories.
|
RepositoryBatchFormList |
getRepositoryFormsForUpdate(IdList repositoryIds)
Gets the repository forms for updating an existing set of
repositories.
|
UpdateResponseList |
updateRepositories(RepositoryBatchFormList repositoryForms)
Updates existing repositories.
|
aliasRepository, canCreateRepositories, canCreateRepositoryWithRecordTypes, canDeleteRepositories, canManageRepositoryAliases, canUpdateRepositories, createRepository, deleteRepository, getRepositoryFormForCreate, getRepositoryFormForUpdate, updateRepository
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RepositoryBatchFormList getRepositoryFormsForCreate(long number, Type[] repositoryRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieverepositoryRecordTypes
- array of repository record types to be
included in each create operation or an empty list if noneNullArgumentException
- repositoryRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createRepositories(RepositoryBatchFormList repositoryForms) throws OperationFailedException, PermissionDeniedException
Repositories.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.repositoryForms
- the repository formsNullArgumentException
- repositoryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RepositoryBatchFormList getRepositoryFormsForUpdate(IdList repositoryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
repositoryIds
- the Ids
of the Repository
NotFoundException
- an repositoryId
is
not foundNullArgumentException
- repositoryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateRepositories(RepositoryBatchFormList repositoryForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.repositoryForms
- the form containing the elements to be updatedNullArgumentException
- repositoryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllRepositories() throws OperationFailedException, PermissionDeniedException
Repositories.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteRepositories(IdList repositoryIds) throws OperationFailedException, PermissionDeniedException
Ids.
repositoryIds
- the Ids
of the repositories to
deleteNullArgumentException
- repositoryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasRepositories(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Repository
for the
purpose of creating compatibility. The primary Id
of
the Repository
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another repository, it is reassigned to the
given repository Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.