org.osid.configuration

Interface ConfigurationProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ConfigurationProfile, OsidProfile, OsidProxyManager, Sourceable

public interface ConfigurationProxyManager
extends OsidProxyManager, ConfigurationProfile

The configuration manager provides access to sessions to retrieve and manage configurations. Methods in this manager support the passing a Proxy. A manager may support federation in that values can be accessed in a specified configuration and paramaters may be defined in a specified registry. The sessions included in this manager are:

• ValueRetrievalSession: a basic session for retrieving configuration values
• ValueLookupSession: a basic session for looking up configuration values
• ValueQuerySession: a basic session for querying configuration values
• ValueSearchSession: a basic session for searching configuration values
• ValueAdminSession: a session for setting and changing configuration values
• ValueNotificationSession: a session for subscribing to changes of configuration values

• ParameterLookupSession: a session for retrieving defined parameters
• ParameterQuerySession: a session for querying defined parameters
• ParameterSearchSession: a session for searching defined parameters
• ParameterAdminSession: a session for creating, updating and deleting parameter definitions
• ParameterNoitificationSession: a session for subscribing to adds and changes of parameters
• ParamaterRegistrySession: a session for examining mappings of parameters to registries
• ParamaterRegistryAssignmentSession: a session for making mappings of parameters to registries
• ParameterConfigurationSession: a session for examining mappings of parameters to configurations
• ParameterConfigurationAssignmentSession: a session for mapping parameters to configurations
• ParameterSmartConfigurationSession: a session for managing smart configurations of parameters

• ConfigurationLookupSession: a session for retrieving configurations
• ConfigurationQuerySession: a session for querying configurations
• ConfigurationSearchSession: a session for searching configurations
• ConfigurationAdminSession: a session for creating and updating configurations
• ConfigurationNotificationSession: a session for subscribing to adds and changes to configurations
• ConfigurationHierarchySession: a session for traversing a hierarchy of configurations
• ConfigurationHierarchyDesignSession: a session for managing a hierarchy of configurations

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurationAdminSession	getConfigurationAdminSession(Proxy proxy) Gets a configuration administration session.
ConfigurationBatchProxyManager	getConfigurationBatchProxyManager() Gets a ConfigurationProxyManager.
ConfigurationHierarchyDesignSession	getConfigurationHierarchyDesignSession(Proxy proxy) Gets a hierarchy design service for configurations.
ConfigurationHierarchySession	getConfigurationHierarchySession(Proxy proxy) Gets a hierarchy traversal service for configurations.
ConfigurationLookupSession	getConfigurationLookupSession(Proxy proxy) Gets a configuration lookup session.
ConfigurationNotificationSession	getConfigurationNotificationSession(ConfigurationReceiver configurationReceiver, Proxy proxy) Gets the notification session for subscribing to changes to configurations.
ConfigurationQuerySession	getConfigurationQuerySession(Proxy proxy) Gets a configuration query session.
ConfigurationRulesProxyManager	getConfigurationRulesProxyManager() Gets a ConfigurationProxyManager.
ConfigurationSearchSession	getConfigurationSearchSession(Proxy proxy) Gets a configuration search session.
ParameterAdminSession	getParameterAdminSession(Proxy proxy) Gets a parameter administration session.
ParameterAdminSession	getParameterAdminSessionForConfiguration(Id configurationId, Proxy proxy) Gets a parameter administration session using the supplied configuration.
ParameterConfigurationAssignmentSession	getParameterConfigurationAssignmentSession(Proxy proxy) Gets a session for managing mappings of parameters to configurations.
ParameterConfigurationSession	getParameterConfigurationSession(Proxy proxy) Gets a session for examining mappings of parameters to configurations.
ParameterLookupSession	getParameterLookupSession(Proxy proxy) Gets a parameter lookup session
ParameterLookupSession	getParameterLookupSessionForConfiguration(Id configurationId, Proxy proxy) Gets a parameter lookup session using the supplied configuration.
ParameterNotificationSession	getParameterNotificationSession(ParameterReceiver parameterReceiver, Proxy proxy) Gets a parameter notification session.
ParameterNotificationSession	getParameterNotificationSessionForConfiguration(ParameterReceiver parameterReceiver, Id configurationId, Proxy proxy) Gets a parameter notification session using the specified configuration.
ParameterQuerySession	getParameterQuerySession(Proxy proxy) Gets a parameter query session
ParameterQuerySession	getParameterQuerySessionForConfiguration(Id configurationId, Proxy proxy) Gets a parameter query session using the supplied configuration.
ParameterSearchSession	getParameterSearchSession(Proxy proxy) Gets a parameter search session
ParameterSearchSession	getParameterSearchSessionForConfiguration(Id configurationId, Proxy proxy) Gets a parameter search session using the supplied configuration.
ParameterSmartConfigurationSession	getParameterSmartConfigurationSession(Id configurationId, Proxy proxy) Gets a session for managing smart configurations of parameters.
ValueAdminSession	getValueAdminSession(Proxy proxy) Gets a configuration value administration session.
ValueAdminSession	getValueAdminSessionForConfiguration(Id configurationId, Proxy proxy) Gets a value administration session using the supplied configuration.
ValueLookupSession	getValueLookupSession(Proxy proxy) Gets a configuration value lookup session.
ValueLookupSession	getValueLookupSessionForConfiguration(Id configurationId, Proxy proxy) Gets a configuration value lookup session using the supplied configuration.
ValueNotificationSession	getValueNotificationSession(ValueReceiver valueReceiver, Proxy proxy) Gets a value notification session.
ValueNotificationSession	getValueNotificationSessionForConfiguration(ValueReceiver valueReceiver, Id configurationId, Proxy proxy) Gets a value notification session using the specified configuration
ValueQuerySession	getValueQuerySession(Proxy proxy) Gets a configuration value query session.
ValueQuerySession	getValueQuerySessionForConfiguration(Id configurationId, Proxy proxy) Gets a configuration value query session using the supplied configuration.
ValueRetrievalSession	getValueRetrievalSession(Proxy proxy) Gets a configuration value retrieval session.
ValueRetrievalSession	getValueRetrievalSessionForConfiguration(Id configurationId, Proxy proxy) Gets a configuration value retrieval session using the supplied configuration.
ValueSearchSession	getValueSearchSession(Proxy proxy) Gets a configuration value search session.
ValueSearchSession	getValueSearchSessionForConfiguration(Id configurationId, Proxy proxy) Gets a configuration value search session using the supplied configuration.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.configuration.ConfigurationProfile

getConfigurationRecordTypes, getConfigurationSearchRecordTypes, getParameterRecordTypes, getParameterSearchRecordTypes, getValueConditionRecordTypes, getValueRecordTypes, getValueSearchRecordTypes, supportsConfigurationAdmin, supportsConfigurationBatch, supportsConfigurationHierarchy, supportsConfigurationHierarchyDesign, supportsConfigurationLookup, supportsConfigurationNotification, supportsConfigurationQuery, supportsConfigurationRecordType, supportsConfigurationRules, supportsConfigurationSearch, supportsConfigurationSearchRecordType, supportsParameterAdmin, supportsParameterConfiguration, supportsParameterConfigurationAssignment, supportsParameterLookup, supportsParameterNotification, supportsParameterQuery, supportsParameterRecordType, supportsParameterSearch, supportsParameterSearchRecordType, supportsParameterSmartConfiguration, supportsValueAdmin, supportsValueConditionRecordType, supportsValueLookup, supportsValueNotification, supportsValueQuery, supportsValueRecordType, supportsValueRetrieval, supportsValueSearch, supportsValueSearchRecordType, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getValueRetrievalSession

ValueRetrievalSession getValueRetrievalSession(Proxy proxy)
                                               throws OperationFailedException

Gets a configuration value retrieval session.

Parameters:

proxy - a proxy

Returns:

a ValueRetrievalSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueRetrieval() is false

Compliance:

optional - This method must be implemented if supportsValueRetrieval() is true.

getValueRetrievalSessionForConfiguration

ValueRetrievalSession getValueRetrievalSessionForConfiguration(Id configurationId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets a configuration value retrieval session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ValueRetrievalSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueRetrieval() or supportsVisibleFederation() is False

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsValueRetrieval() are true

getValueLookupSession

ValueLookupSession getValueLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets a configuration value lookup session.

Parameters:

proxy - a proxy

Returns:

a ValueLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueLookup() is false

Compliance:

optional - This method must be implemented if supportsValueLookup() is true.

getValueLookupSessionForConfiguration

ValueLookupSession getValueLookupSessionForConfiguration(Id configurationId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets a configuration value lookup session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ValueLookupSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueLookup() or supportsVisibleFederation() is False

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsValueLookup() are true

getValueQuerySession

ValueQuerySession getValueQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets a configuration value query session.

Parameters:

proxy - a proxy

Returns:

a ValueQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueQuery() is false

Compliance:

optional - This method must be implemented if supportsValueQuery() is true.

getValueQuerySessionForConfiguration

ValueQuerySession getValueQuerySessionForConfiguration(Id configurationId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets a configuration value query session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ValueQuerySession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueQuery() or supportsVisibleFederation() is False

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsValueQuery() are true

getValueSearchSession

ValueSearchSession getValueSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets a configuration value search session.

Parameters:

proxy - a proxy

Returns:

a ValueSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueSearch() is false

Compliance:

optional - This method must be implemented if supportsValueLookup() is true.

getValueSearchSessionForConfiguration

ValueSearchSession getValueSearchSessionForConfiguration(Id configurationId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets a configuration value search session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ValueSearchSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueSearch() or supportsVisibleFederation() is False

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsValueSearch() are true

getValueNotificationSession

ValueNotificationSession getValueNotificationSession(ValueReceiver valueReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets a value notification session.

Parameters:

valueReceiver - notification callback

proxy - a proxy

Returns:

a ValueNotificationSession

Throws:

NullArgumentException - valueReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueNotification() is false

Compliance:

optional - This method must be implemented if supportsValueNotification() is true.

getValueNotificationSessionForConfiguration

ValueNotificationSession getValueNotificationSessionForConfiguration(ValueReceiver valueReceiver,
                                                                   Id configurationId,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets a value notification session using the specified configuration

Parameters:

valueReceiver - notification callback

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ValueNotificationSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - valueReceiver, configurationId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsValueNotification() are true.

getValueAdminSession

ValueAdminSession getValueAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets a configuration value administration session.

Parameters:

proxy - a proxy

Returns:

a ValueAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueAdmin() is false

Compliance:

optional - This method must be implemented if supportsValueAdmin() is true.

getValueAdminSessionForConfiguration

ValueAdminSession getValueAdminSessionForConfiguration(Id configurationId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets a value administration session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ValueAdminSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsValueAdmin() are true.

getParameterLookupSession

ParameterLookupSession getParameterLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets a parameter lookup session

Parameters:

proxy - a proxy

Returns:

a ParameterLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterLookup() is false

Compliance:

optional - This method must be implemented if supportsParameterLookup() is true.

getParameterLookupSessionForConfiguration

ParameterLookupSession getParameterLookupSessionForConfiguration(Id configurationId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets a parameter lookup session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ParamaterLookupSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsParameterLookup() are true.

getParameterQuerySession

ParameterQuerySession getParameterQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets a parameter query session

Parameters:

proxy - a proxy

Returns:

a ParameterQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterQuery() is false

Compliance:

optional - This method must be implemented if supportsParameterQuery() is true.

getParameterQuerySessionForConfiguration

ParameterQuerySession getParameterQuerySessionForConfiguration(Id configurationId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets a parameter query session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ParamaterQuerySession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsParameterQuery() are true.

getParameterSearchSession

ParameterSearchSession getParameterSearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets a parameter search session

Parameters:

proxy - a proxy

Returns:

a ParameterSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterSearch() is false

Compliance:

optional - This method must be implemented if supportsParameterSearch() is true.

getParameterSearchSessionForConfiguration

ParameterSearchSession getParameterSearchSessionForConfiguration(Id configurationId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets a parameter search session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ParamaterSearchSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsParameterSearch() are true.

getParameterAdminSession

ParameterAdminSession getParameterAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets a parameter administration session.

Parameters:

proxy - a proxy

Returns:

a ParameterAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterAdmin() is false

Compliance:

optional - This method must be implemented if supportsParameterAdmin() is true.

getParameterAdminSessionForConfiguration

ParameterAdminSession getParameterAdminSessionForConfiguration(Id configurationId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets a parameter administration session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ParameterAdminSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsParameterAdmin() are true.

getParameterNotificationSession

ParameterNotificationSession getParameterNotificationSession(ParameterReceiver parameterReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets a parameter notification session.

Parameters:

parameterReceiver - notification callback

proxy - a proxy

Returns:

a ParameterNotificationSession

Throws:

NullArgumentException - parameterReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterNotification() is false

Compliance:

optional - This method must be implemented if supportsParameterNotification() is true.

getParameterNotificationSessionForConfiguration

ParameterNotificationSession getParameterNotificationSessionForConfiguration(ParameterReceiver parameterReceiver,
                                                                           Id configurationId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

Gets a parameter notification session using the specified configuration.

Parameters:

parameterReceiver - notification callback

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ParameterNotificationSession

Throws:

NotFoundException - registryId is not found

NullArgumentException - parameterReceiver, configurationId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsVisibleFederation() and supportsParameterNotification() are true.

getParameterConfigurationSession

ParameterConfigurationSession getParameterConfigurationSession(Proxy proxy)
                                                               throws OperationFailedException

Gets a session for examining mappings of parameters to configurations.

Parameters:

proxy - a proxy

Returns:

a ParameterConfigurationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterConfiguration() is false

Compliance:

optional - This method must be implemented if supportsParameterConfiguration() is true.

getParameterConfigurationAssignmentSession

ParameterConfigurationAssignmentSession getParameterConfigurationAssignmentSession(Proxy proxy)
                                                                                   throws OperationFailedException

Gets a session for managing mappings of parameters to configurations.

Parameters:

proxy - a proxy

Returns:

a ParameterConfigurationAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterConfigurationAssignment() is false

Compliance:

optional - This method must be implemented if supportsParameterConfigurationAssignment() is true.

getParameterSmartConfigurationSession

ParameterSmartConfigurationSession getParameterSmartConfigurationSession(Id configurationId,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets a session for managing smart configurations of parameters.

Parameters:

configurationId - the Id of the Configuration to use

proxy - a proxy

Returns:

a ParameterSmartConfigurationSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configuratinId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterSmartConfiguration() is false

Compliance:

optional - This method must be implemented if supportsParameterSmartConfiguration() is true.

getConfigurationLookupSession

ConfigurationLookupSession getConfigurationLookupSession(Proxy proxy)
                                                         throws OperationFailedException

Gets a configuration lookup session.

Parameters:

proxy - a proxy

Returns:

a ConfigurationLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationLookup() is false

Compliance:

optional - This method must be implemented if supportsConfigurationLookup() is true.

getConfigurationQuerySession

ConfigurationQuerySession getConfigurationQuerySession(Proxy proxy)
                                                       throws OperationFailedException

Gets a configuration query session.

Parameters:

proxy - a proxy

Returns:

a ConfigurationQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationQuery() is false

Compliance:

optional - This method must be implemented if supportsConfigurationQuery() is true.

getConfigurationSearchSession

ConfigurationSearchSession getConfigurationSearchSession(Proxy proxy)
                                                         throws OperationFailedException

Gets a configuration search session.

Parameters:

proxy - a proxy

Returns:

a ConfigurationSearchSession

Throws:

OperationFailedException - proxy is null

NullArgumentException - unable to complete request

UnimplementedException - supportsConfigurationSearch() is false

Compliance:

optional - This method must be implemented if supportsConfigurationSearch() is true.

getConfigurationNotificationSession

ConfigurationNotificationSession getConfigurationNotificationSession(ConfigurationReceiver configurationReceiver,
                                                                   Proxy proxy)
                                                                     throws OperationFailedException

Gets the notification session for subscribing to changes to configurations.

Parameters:

configurationReceiver - notification callback

proxy - a proxy

Returns:

a ConfigurationNotificationSession

Throws:

NullArgumentException - configurationReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationNotification() is false

Compliance:

optional - This method must be implemented if supportsConfigurationNotification() is true.

getConfigurationAdminSession

ConfigurationAdminSession getConfigurationAdminSession(Proxy proxy)
                                                       throws OperationFailedException

Gets a configuration administration session.

Parameters:

proxy - a proxy

Returns:

a ConfigurationAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationAdmin() is false

Compliance:

optional - This method must be implemented if supportsConfigurationAdmin() is true.

getConfigurationHierarchySession

ConfigurationHierarchySession getConfigurationHierarchySession(Proxy proxy)
                                                               throws OperationFailedException

Gets a hierarchy traversal service for configurations.

Parameters:

proxy - a proxy

Returns:

a ConfiguraqtionHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationHierarchy() is false

Compliance:

optional - This method must be implemented if supportsConfigurationHierarchy() is true.

getConfigurationHierarchyDesignSession

ConfigurationHierarchyDesignSession getConfigurationHierarchyDesignSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets a hierarchy design service for configurations.

Parameters:

proxy - a proxy

Returns:

a ConfigurationHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsConfigurationHierarchyDesign() is true.

getConfigurationBatchProxyManager

ConfigurationBatchProxyManager getConfigurationBatchProxyManager()
                                                                 throws OperationFailedException

Gets a ConfigurationProxyManager.

Returns:

a ConfigurationBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationBatch() is false

Compliance:

optional - This method must be implemented if supportsConfigurationBatch() is true.

getConfigurationRulesProxyManager

ConfigurationRulesProxyManager getConfigurationRulesProxyManager()
                                                                 throws OperationFailedException

Gets a ConfigurationProxyManager.

Returns:

a ConfigurationRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationRules() is false

Compliance:

optional - This method must be implemented if supportsConfigurationRules() is true.