org.osid.control.batch

Interface SettingBatchAdminSession

All Superinterfaces:

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

public interface SettingBatchAdminSession
extends SettingAdminSession

This session creates, updates, and deletes Settings 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 Setting, a SettingForm is requested using getSettingFormsForCreate() specifying the desired controller and record Types or none if no record Types are needed. Each of the returned SettingForms 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 SettingForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each SettingForm corresponds to an attempted transaction.

The SettingForms returned from getSettingFormsForCreate() may be linked to the originating request through the peer Ids of the SettingForm. In the case where there may be duplicates, any SettingForm of the same peer Ids may be used for a create operation.

Once a batch of SettingForm are submitted for create, a CreateSetting is returned for each SettingForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createSettings(), errors specific to an individual SettingForm are indicated in the corresponding CreateSetting. CreateSettings may be linked to the originating SettingForm through the SettingForm Id .

For updates, SettingForms are requested to the Setting Id that is to be updated using getSettingFormsForUpdate() where the reference Id in the SettingForm may be used to link the request. Similarly, the SettingForm has metadata about the data that can be updated and it can perform validation before submitting the update. The SettingForm can only be used once for a successful update and cannot be reused.

Once a batch of SettingForms are submitted for update, an UpdateSetting is returned for each SettingForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateSettings(), errors specific to an individual SettingForm are indicated in the corresponding UpdateSetting. UpdateSettings may be linked to the originating SettingForm through the SettingForm Id.

The delete operations delete Settings in bulk. To unmap a Setting from the current System, the SettingSystemAssignmentSession should be used. These delete operations attempt to remove the Setting itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteSettings.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasSettings(AliasRequestList aliasRequests) Adds an Id to a Setting for the purpose of creating compatibility.
CreateResponseList	createSettings(SettingBatchFormList settingForms) Creates a new set of Settings.
DeleteResponseList	deleteAllSettings() Deletes all Settings in this System.
DeleteResponseList	deleteSettings(IdList settingIds) Deletes settings for the given Ids.
DeleteResponseList	deleteSettingsForController(Id controllerId) Deletes settings for the given Controller.
SettingBatchFormList	getSettingFormsForCreate(IdList controllerIds, Type[] settingRecordTypes) Gets the setting forms for creating a bunch of new settings.
SettingBatchFormList	getSettingFormsForUpdate(IdList settingIds) Gets the setting forms for updating an existing set of settings.
UpdateResponseList	updateSettings(SettingBatchFormList settingForms) Updates existing settings.

Methods inherited from interface org.osid.control.SettingAdminSession

aliasSetting, canCreateSettings, canCreateSettingWithRecordTypes, canDeleteSettings, canManageSettingAliases, canUpdateSettings, createSetting, deleteSetting, getSettingFormForCreate, getSettingFormForUpdate, getSystem, getSystemId, updateSetting

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

getSettingFormsForCreate

SettingBatchFormList getSettingFormsForCreate(IdList controllerIds,
                                            Type[] settingRecordTypes)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the setting forms for creating a bunch of new settings. A form is retrieved for each controller.

Parameters:

controllerIds - list of controller Ids

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

Returns:

the setting forms

Throws:

NotFoundException - a controllerId is not found

NullArgumentException - controllerIds or settingRecordTypes 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.

createSettings

CreateResponseList createSettings(SettingBatchFormList settingForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

settingForms - the setting forms

Returns:

the create responses

Throws:

NullArgumentException - settingForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSettingFormsForUpdate

SettingBatchFormList getSettingFormsForUpdate(IdList settingIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

settingIds - the Ids of the Setting

Returns:

the setting form

Throws:

NotFoundException - a settingId is not found

NullArgumentException - settingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateSettings

UpdateResponseList updateSettings(SettingBatchFormList settingForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

settingForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - settingForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllSettings

DeleteResponseList deleteAllSettings()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Settings in this System.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSettings

DeleteResponseList deleteSettings(IdList settingIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes settings for the given Ids.

Parameters:

settingIds - the Ids of the settings to delete

Returns:

the delete responses

Throws:

NullArgumentException - settingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSettingsForController

DeleteResponseList deleteSettingsForController(Id controllerId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Deletes settings for the given Controller.

Parameters:

controllerId - a controller Id

Returns:

the delete responses

Throws:

NullArgumentException - controllerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasSettings

AliasResponseList aliasSettings(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

Adds an Id to a Setting for the purpose of creating compatibility. The primary Id of the Setting is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another setting, it is reassigned to the given setting 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.