org.osid.configuration.batch

Interface ConfigurationBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ConfigurationAdminSession, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.configuration.ConfigurationAdminSession

aliasConfiguration, canCreateConfigurations, canCreateConfigurationWithRecordTypes, canDeleteConfigurations, canManageConfigurationAliases, canUpdateConfigurations, createConfiguration, deleteConfiguration, getConfigurationFormForCreate, getConfigurationFormForUpdate, updateConfiguration

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getConfigurationFormsForCreate

ConfigurationBatchFormList getConfigurationFormsForCreate(long number,
                                                        Type[] configurationRecordTypes)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets the configuration forms for creating a bunch of new configurations.

Parameters:

number - the number of forms to retrieve

configurationRecordTypes - array of configuration record types to be included in each create operation or an empty list if none

Returns:

the configuration forms

Throws:

NullArgumentException - configurationRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createConfigurations

CreateResponseList createConfigurations(ConfigurationBatchFormList configurationForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Creates a new set of Configurations. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

configurationForms - the configuration forms

Returns:

the create responses

Throws:

NullArgumentException - configurationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationFormsForUpdate

ConfigurationBatchFormList getConfigurationFormsForUpdate(IdList configurationIds)
                                                          throws NotFoundException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

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

Parameters:

configurationIds - the Ids of the Configuration

Returns:

the configuration form

Throws:

NotFoundException - an configurationId is not found

NullArgumentException - configurationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateConfigurations

UpdateResponseList updateConfigurations(ConfigurationBatchFormList configurationForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Updates existing configurations. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

configurationForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - configurationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllConfigurations

DeleteResponseList deleteAllConfigurations()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes all Configurations.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteConfigurations

DeleteResponseList deleteConfigurations(IdList configurationIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes configurations for the given Ids.

Parameters:

configurationIds - the Ids of the configurations to delete

Returns:

the delete responses

Throws:

NullArgumentException - configurationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasConfigurations

AliasResponseList aliasConfigurations(AliasRequestList aliasRequests)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Adds an 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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.