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.
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.
|
aliasSetting, canCreateSettings, canCreateSettingWithRecordTypes, canDeleteSettings, canManageSettingAliases, canUpdateSettings, createSetting, deleteSetting, getSettingFormForCreate, getSettingFormForUpdate, getSystem, getSystemId, updateSetting
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
SettingBatchFormList getSettingFormsForCreate(IdList controllerIds, Type[] settingRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
controllerIds
- list of controller Ids
settingRecordTypes
- array of setting record types to be
included in each create operation or an empty list if noneNotFoundException
- a controllerId
is
not foundNullArgumentException
- controllerIds
or
settingRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createSettings(SettingBatchFormList settingForms) throws OperationFailedException, PermissionDeniedException
Settings.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateSetting
.settingForms
- the setting formsNullArgumentException
- settingForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SettingBatchFormList getSettingFormsForUpdate(IdList settingIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
settingIds
- the Ids
of the Setting
NotFoundException
- a settingId
is not
foundNullArgumentException
- settingIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateSettings(SettingBatchFormList settingForms) throws OperationFailedException, PermissionDeniedException
BatchCreateSetting
.settingForms
- the form containing the elements to be updatedNullArgumentException
- settingForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllSettings() throws OperationFailedException, PermissionDeniedException
Settings
in this System.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteSettings(IdList settingIds) throws OperationFailedException, PermissionDeniedException
Ids.
settingIds
- the Ids
of the settings to deleteNullArgumentException
- settingIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteSettingsForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
Controller.
controllerId
- a controller Id
NullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasSettings(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.