public interface ConfigurationBatchAdminSession extends ConfigurationAdminSession
This session creates, updates, and deletes Configurations
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
Configuration,
an ConfigurationForm
is
requested using getConfigurationFormsForCreate()
specifying
the desired record Types
or none if no record Types
are needed. Each of the returned ConfigurationForms
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
ConfigurationForm
is submiited to a create operation, it cannot be
reused with another create operation unless the first operation was
unsuccessful. Each ConfigurationForm
corresponds to an
attempted transaction.
The ConfigurationForms
returned from
getConfigurationFormsForCreate()
may be linked to the originating
request through the peer Ids
of the
ConfigurationForm.
In the case where there may be duplicates, any
ConfigurationForm
of the same peer Ids
may
be used for a create operation.
Once a batch of ConfigurationForms
are submitted for
create, a CreateResponse
is returned for each
ConfigurationForm,
although the ordering is not defined. Only
errors that pertain to the entire create operation are returned from
createConfigurations(),
errors specific to an individual
ConfigurationForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating ConfigurationForm
through the
ConfigurationForm
Id
.
For updates, ConfigurationForms
are requested to the
Configuration
Id
that is to be updated using
getConfigurationFormsForUpdate()
where the reference
Id
in the ConfigurationForm
may be used to link the
request. Similarly, the ConfigurationForm
has metadata
about the data that can be updated and it can perform validation before
submitting the update. The ConfigurationForm
can only be
used once for a successful update and cannot be reused.
Once a batch of ConfigurationForms
are submitted for
update, an UpdateResponse
is returned for each
ConfigurationForm,
although the ordering is not defined. Only
errors that pertain to the entire update operation are returned from
updateConfigurations(),
errors specific to an individual
ConfigurationForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating ConfigurationForm
through the
ConfigurationForm
Id.
The delete operations delete Configurations
in bulk.
Bulk delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasConfigurations(AliasRequestList aliasRequests)
Adds an
Id to an Configuration for the
purpose of creating compatibility. |
CreateResponseList |
createConfigurations(ConfigurationBatchFormList configurationForms)
Creates a new set of
Configurations. |
DeleteResponseList |
deleteAllConfigurations()
Deletes all
Configurations. |
DeleteResponseList |
deleteConfigurations(IdList configurationIds)
Deletes configurations for the given
Ids. |
ConfigurationBatchFormList |
getConfigurationFormsForCreate(long number,
Type[] configurationRecordTypes)
Gets the configuration forms for creating a bunch of new
configurations.
|
ConfigurationBatchFormList |
getConfigurationFormsForUpdate(IdList configurationIds)
Gets the configuration forms for updating an existing set of
configurations.
|
UpdateResponseList |
updateConfigurations(ConfigurationBatchFormList configurationForms)
Updates existing configurations.
|
aliasConfiguration, canCreateConfigurations, canCreateConfigurationWithRecordTypes, canDeleteConfigurations, canManageConfigurationAliases, canUpdateConfigurations, createConfiguration, deleteConfiguration, getConfigurationFormForCreate, getConfigurationFormForUpdate, updateConfiguration
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ConfigurationBatchFormList getConfigurationFormsForCreate(long number, Type[] configurationRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveconfigurationRecordTypes
- array of configuration record types
to be included in each create operation or an empty list if
noneNullArgumentException
- configurationRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createConfigurations(ConfigurationBatchFormList configurationForms) throws OperationFailedException, PermissionDeniedException
Configurations.
This method
returns an error if the entire operation fails. Otherwise, the status
of an individual create operation is indicated in the
BatchCreateResponse
.configurationForms
- the configuration formsNullArgumentException
- configurationForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConfigurationBatchFormList getConfigurationFormsForUpdate(IdList configurationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
configurationIds
- the Ids
of the
Configuration
NotFoundException
- an configurationId
is not foundNullArgumentException
- configurationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateConfigurations(ConfigurationBatchFormList configurationForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.configurationForms
- the form containing the elements to be
updatedNullArgumentException
- configurationForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllConfigurations() throws OperationFailedException, PermissionDeniedException
Configurations.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
Ids.
configurationIds
- the Ids
of the configurations
to deleteNullArgumentException
- configurationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasConfigurations(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Configuration
for the
purpose of creating compatibility. The primary Id
of
the Configuration
is determined by the provider. The
new Id
is an alias to the primary Id.
If
the alias is a pointer to another configuration, it is reassigned to
the given entry Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.