public interface ConfigurationBatchProxyManager extends OsidProxyManager, ConfigurationBatchProfile
The configuration batch proxy manager provides access to configuration
batch sessions and provides interoperability tests for various aspects of
this service. Methods in this manager support the passing of a
Proxy
object. 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(Proxy proxy)
Gets the
OsidSession associated with the bulk
configuration administration service. |
ParameterBatchAdminSession |
getParameterBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk parameter
administration service. |
ParameterBatchAdminSession |
getParameterBatchAdminSessionForConfiguration(Id configurationId,
Proxy proxy)
Gets the
OsidSession associated with the bulk parameter
administration service for the given configuration. |
ValueBatchAdminSession |
getValueBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk value
administration service. |
ValueBatchAdminSession |
getValueBatchAdminSessionForConfiguration(Id configurationId,
Proxy proxy)
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk value
administration service.proxy
- a proxy ValueBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsValueBatchAdmin()
is false
optional
- This method must be implemented if
supportsValueBatchAdmin()
is true.
ValueBatchAdminSession getValueBatchAdminSessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk value
administration service for the given configuration.configurationId
- the Id
of the
Configuration
proxy
- a proxy ValueBatchAdminSession
NotFoundException
- no Configuration
found by the given Id
NullArgumentException
- configurationId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk parameter
administration service.proxy
- a proxy ParameterBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterBatchAdmin()
is false
optional
- This method must be implemented if
supportsParameterBatchAdmin()
is true.
ParameterBatchAdminSession getParameterBatchAdminSessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk parameter
administration service for the given configuration.configurationId
- the Id
of the
Configuration
proxy
- a proxy ParameterBatchAdminSession
NotFoundException
- no Configuration
found by the given Id
NullArgumentException
- configurationId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk
configuration administration service.proxy
- a proxy ConfigurationBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationBatchAdmin()
is false
optional
- This method must be implemented if
supportsConfigurationBatchAdmin()
is true.