public interface ConfigurationBatchManager extends OsidManager, ConfigurationBatchProfile
The configuration batch manager provides access to configuration batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
ValueBatchAdminSession:
a session to create,
modify and delete values in bulk ParameterBatchSession:
a session to create, modify
and delete parameters in bulk ConfigurationBatchAdminSession:
a session to
create, modify and delete configurations in bulk Modifier and Type | Method and Description |
---|---|
ConfigurationBatchAdminSession |
getConfigurationBatchAdminSession()
Gets the
OsidSession associated with the bulk
configuration administration service. |
ParameterBatchAdminSession |
getParameterBatchAdminSession()
Gets the
OsidSession associated with the bulk parameter
administration service. |
ParameterBatchAdminSession |
getParameterBatchAdminSessionForConfiguration(Id configurationId)
Gets the
OsidSession associated with the bulk parameter
administration service for the given configuration. |
ValueBatchAdminSession |
getValueBatchAdminSession()
Gets the
OsidSession associated with the bulk value
administration service. |
ValueBatchAdminSession |
getValueBatchAdminSessionForConfiguration(Id configurationId)
Gets the
OsidSession associated with the bulk value
administration service for the given configuration. |
changeBranch, initialize, rollbackService
close
supportsConfigurationBatchAdmin, supportsParameterBatchAdmin, supportsValueBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ValueBatchAdminSession getValueBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk value
administration service. ValueBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsValueBatchAdmin()
is false
optional
- This method must be implemented if
supportsValueBatchAdmin()
is true.
ValueBatchAdminSession getValueBatchAdminSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk value
administration service for the given configuration.configurationId
- the Id
of the
Configuration
ValueBatchAdminSession
NotFoundException
- no Configuration
found by the given Id
NullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsValueBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsValueBatchAdmin()
and
supportsVisibleFederation()
are true
ParameterBatchAdminSession getParameterBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk parameter
administration service. ParameterBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterBatchAdmin()
is false
optional
- This method must be implemented if
supportsParameterBatchAdmin()
is true.
ParameterBatchAdminSession getParameterBatchAdminSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk parameter
administration service for the given configuration.configurationId
- the Id
of the
Configuration
ParameterBatchAdminSession
NotFoundException
- no Configuration
found by the given Id
NullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsParameterBatchAdmin()
and
supportsVisibleFederation()
are true
ConfigurationBatchAdminSession getConfigurationBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk
configuration administration service. ConfigurationBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationBatchAdmin()
is false
optional
- This method must be implemented if
supportsConfigurationBatchAdmin()
is true.