Interface ConfigurationManager

All Superinterfaces:

AutoCloseable, Closeable, ConfigurationProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface ConfigurationManager
extends OsidManager, ConfigurationProfile

The configuration manager provides access sessions to retrieve and manage configurations. A manager may support federation in that values can be accessed in a specified configuration and parameters 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

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

Methods inherited from interface Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getConfigurationRecordTypes()	Gets all the configuration record types supported.
TypeList	getConfigurationSearchRecordTypes()	Gets all the configuration search record types supported.
TypeList	getParameterRecordTypes()	Gets all the parameter record types supported.
TypeList	getParameterSearchRecordTypes()	Gets all the parameter search record types supported.
TypeList	getValueConditionRecordTypes()	Gets the supported value condition record types.
TypeList	getValueRecordTypes()	Gets all the value record types supported.
TypeList	getValueSearchRecordTypes()	Gets all the value search record types supported.
boolean	supportsConfigurationAdmin()	Tests for the availability of a configuration admin service.
boolean	supportsConfigurationBatch()	Tests for the availability of a configuration batch service.
boolean	supportsConfigurationHierarchy()	Tests for the availability of a configuration hierarchy traversal service.
boolean	supportsConfigurationHierarchyDesign()	Tests for the availability of a configuration hierarchy design service.
boolean	supportsConfigurationLookup()	Tests for the availability of a configuration lookup service.
boolean	supportsConfigurationNotification()	Tests for the availability of a notification service for subscribing to changes to configurations.
boolean	supportsConfigurationQuery()	Tests for the availability of a configuration query service.
boolean	supportsConfigurationRecordType(Type configurationRecordType)	Tests if a given configuration record type is supported.
boolean	supportsConfigurationRules()	Tests for the availability of a configuration rules service.
boolean	supportsConfigurationSearch()	Tests for the availability of a configuration search service.
boolean	supportsConfigurationSearchRecordType(Type configurationSearchRecordType)	Tests if a given configuration search record type is supported.
boolean	supportsParameterAdmin()	Tests for the availability of a parameter update service.
boolean	supportsParameterConfiguration()	Tests for the availability of a service to lookup mappings of parameters to configurations.
boolean	supportsParameterConfigurationAssignment()	Tests for the availability of a service to map parameters to configurations.
boolean	supportsParameterLookup()	Tests for the availability of a parameter lookup service.
boolean	supportsParameterNotification()	Tests for the availability of a parameter notification service.
boolean	supportsParameterQuery()	Tests for the availability of a parameter query service.
boolean	supportsParameterRecordType(Type parameterRecordType)	Tests if a given parameter record type is supported.
boolean	supportsParameterSearch()	Tests for the availability of a parameter search service.
boolean	supportsParameterSearchRecordType(Type parameterSearchRecordType)	Tests if a given parameter search record type is supported.
boolean	supportsParameterSmartConfiguration()	Tests for the availability of a parameter smart configuration service.
boolean	supportsValueAdmin()	Tests for the availability of a configuration value administration service.
boolean	supportsValueConditionRecordType(Type valueConditionRecordType)	Tests if the given ValueCondition record type is supported.
boolean	supportsValueLookup()	Tests for the availability of a configuration value lookup service.
boolean	supportsValueNotification()	Tests for the availability of a configuration value notification service.
boolean	supportsValueQuery()	Tests for the availability of a configuration value query service.
boolean	supportsValueRecordType(Type valueRecordType)	Tests if a given value record type is supported.
boolean	supportsValueRetrieval()	Tests for the availability of a configuration value retrieval service.
boolean	supportsValueSearch()	Tests for the availability of a configuration value search service.
boolean	supportsValueSearchRecordType(Type valueSearchRecordType)	Tests if a given value search type is supported.
boolean	supportsVisibleFederation()	Tests if federation is visible for this service.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getValueRetrievalSession

ValueRetrievalSession getValueRetrievalSession()
                                        throws OperationFailedException

Gets a configuration value retrieval session.

Returns:

a ValueRetrievalSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueRetrieval() is false

Compliance:

optional - This method must be implemented if {@code supportsValueRetrieval()} is {@code true} .

getValueRetrievalSessionForConfiguration

ValueRetrievalSession getValueRetrievalSessionForConfiguration(Id configurationId)
                                                        throws NotFoundException,
OperationFailedException

Gets a configuration value retrieval session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

Returns:

a ValueRetrievalSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueRetrieval() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsVisibleFederation()} and {@code supportsValueRetrieval()} are {@code true} .

getValueLookupSession

ValueLookupSession getValueLookupSession()
                                  throws OperationFailedException

Gets a configuration value lookup session.

Returns:

a ValueLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsValueLookup()} is {@code true} .

getValueLookupSessionForConfiguration

ValueLookupSession getValueLookupSessionForConfiguration(Id configurationId)
                                                  throws NotFoundException,
OperationFailedException

Gets a configuration value lookup session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

Returns:

a ValueLookupSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsVisibleFederation()} and {@code supportsValueLookup()} are {@code true} .

getValueQuerySession

ValueQuerySession getValueQuerySession()
                                throws OperationFailedException

Gets a configuration value query session.

Returns:

a ValueQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsValueQuery()} is {@code true} .

getValueQuerySessionForConfiguration

ValueQuerySession getValueQuerySessionForConfiguration(Id configurationId)
                                                throws NotFoundException,
OperationFailedException

Gets a configuration value query session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

Returns:

a ValueQuerySession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsVisibleFederation()} and {@code supportsValueQuery()} are {@code true} .

getValueSearchSession

ValueSearchSession getValueSearchSession()
                                  throws OperationFailedException

Gets a configuration value search session

Returns:

a ValueSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsValueSearch()} is {@code true} .

getValueSearchSessionForConfiguration

ValueSearchSession getValueSearchSessionForConfiguration(Id configurationId)
                                                  throws NotFoundException,
OperationFailedException

Gets a configuration value search session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

Returns:

a ValueSearchSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsVisibleFederation()} and {@code supportsValueSearch()} are {@code true} .

getValueAdminSession

ValueAdminSession getValueAdminSession()
                                throws OperationFailedException

Gets a configuration value administration session.

Returns:

a ValueAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsValueAdmin()} is {@code true} .

getValueAdminSessionForConfiguration

ValueAdminSession getValueAdminSessionForConfiguration(Id configurationId)
                                                throws NotFoundException,
OperationFailedException

Gets a value administration session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

Returns:

a ValueAdminSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - supportsValueAdmin() or supportsVisibleFederation() is false

UnimplementedException - supportsValueAdmin() or supportsVisibleFederation() is false

Compliance:

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

getValueNotificationSession

ValueNotificationSession getValueNotificationSession(ValueReceiver valueReceiver)
                                              throws OperationFailedException

Gets a value notification session.

Parameters:

valueReceiver - the notification callback

Returns:

a ValueNotificationSession

Throws:

NullArgumentException - valueReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsValueNotification()} is {@code true} .

getValueNotificationSessionForConfiguration

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

Gets a value notification session using the specified configuration

Parameters:

valueReceiver - the notification callback

configurationId - the Id of the Configuration to use

Returns:

a ValueNotificationSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - valueReceiver or configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueNotification() or supportsVisibleFederation() is false

Compliance:

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

getParameterLookupSession

ParameterLookupSession getParameterLookupSession()
                                          throws OperationFailedException

Gets a parameter lookup session

Returns:

a ParameterLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsParameterLookup()} is {@code true} .

getParameterLookupSessionForConfiguration

ParameterLookupSession getParameterLookupSessionForConfiguration(Id configurationId)
                                                          throws NotFoundException,
OperationFailedException

Gets a parameter lookup session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

Returns:

a ParamaterLookupSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterLookup() or supportsVisibleFederation() is false

Compliance:

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

getParameterQuerySession

ParameterQuerySession getParameterQuerySession()
                                        throws OperationFailedException

Gets a parameter query session

Returns:

a ParameterQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsParameterQuery()} is {@code true} .

getParameterQuerySessionForConfiguration

ParameterQuerySession getParameterQuerySessionForConfiguration(Id configurationId)
                                                        throws NotFoundException,
OperationFailedException

Gets a parameter search session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

Returns:

a ParamaterQuerySession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterQuery() or supportsVisibleFederation() is false

Compliance:

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

getParameterSearchSession

ParameterSearchSession getParameterSearchSession()
                                          throws OperationFailedException

Gets a parameter search session

Returns:

a ParameterSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsParameterSearch()} is {@code true} .

getParameterSearchSessionForConfiguration

ParameterSearchSession getParameterSearchSessionForConfiguration(Id configurationId)
                                                          throws NotFoundException,
OperationFailedException

Gets a parameter search session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

Returns:

a ParamaterSearchSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterSearch() or supportsVisibleFederation() is false

Compliance:

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

getParameterAdminSession

ParameterAdminSession getParameterAdminSession()
                                        throws OperationFailedException

Gets a parameter administration session.

Returns:

a ParameterAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsParameterAdmin()} is {@code true} .

getParameterAdminSessionForConfiguration

ParameterAdminSession getParameterAdminSessionForConfiguration(Id configurationId)
                                                        throws NotFoundException,
OperationFailedException

Gets a parameter administration session using the supplied configuration.

Parameters:

configurationId - the Id of the Configuration to use

Returns:

a ParameterAdminSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterSearch() or supportsVisibleFederation() is false

Compliance:

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

getParameterNotificationSession

ParameterNotificationSession getParameterNotificationSession(ParameterReceiver parameterReceiver)
                                                      throws OperationFailedException

Gets a parameter notification session.

Parameters:

parameterReceiver - the notification callback

Returns:

a ParameterNotificationSession

Throws:

NullArgumentException - parameterReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsParameterNotification()} is {@code true} .

getParameterNotificationSessionForConfiguration

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

Gets a parameter notification session using the specified configuration.

Parameters:

parameterReceiver - the notification callback

configurationId - the Id of the Configuration to use

Returns:

a ParameterNotificationSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - parameterReceiver or configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterNotification() or supportsVisibleFederation() is false

Compliance:

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

getParameterConfigurationSession

ParameterConfigurationSession getParameterConfigurationSession()
                                                        throws OperationFailedException

Gets a session for looking up mappings of parameters to configurations.

Returns:

a ParameterConfigurationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterConfiguration() is false

Compliance:

optional - This method must be implemented if {@code supportsParameterConfiguration()} is {@code true} .

getParameterConfigurationAssignmentSession

ParameterConfigurationAssignmentSession getParameterConfigurationAssignmentSession()
                                                                            throws OperationFailedException

Gets a session for managing mappings of parameters to configurations.

Returns:

a ParameterConfigurationAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterConfigurationAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsParameterConfigurationAssignment()} is {@code true} .

getParameterSmartConfigurationSession

ParameterSmartConfigurationSession getParameterSmartConfigurationSession(Id configurationId)
                                                                  throws NotFoundException,
OperationFailedException

Gets a session for managing smart configurations.

Parameters:

configurationId - the Id of the Configuration to use

Returns:

a ParameterSmartConfigurationSession

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterSmartConfiguration() is false

Compliance:

optional - This method must be implemented if {@code supportsParameterSmartConfiguration()} is {@code true} .

getConfigurationLookupSession

ConfigurationLookupSession getConfigurationLookupSession()
                                                  throws OperationFailedException

Gets a configuration lookup session.

Returns:

a ConfigurationLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsConfigurationLookup()} is {@code true} .

getConfigurationQuerySession

ConfigurationQuerySession getConfigurationQuerySession()
                                                throws OperationFailedException

Gets a configuration query session.

Returns:

a ConfigurationQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsConfigurationQuery()} is {@code true} .

getConfigurationSearchSession

ConfigurationSearchSession getConfigurationSearchSession()
                                                  throws OperationFailedException

Gets a configuration search session.

Returns:

a ConfigurationSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsConfigurationSearch()} is {@code true} .

getConfigurationAdminSession

ConfigurationAdminSession getConfigurationAdminSession()
                                                throws OperationFailedException

Gets a configuration administration session.

Returns:

a ConfigurationAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsConfigurationAdmin()} is {@code true} .

getConfigurationNotificationSession

ConfigurationNotificationSession getConfigurationNotificationSession(ConfigurationReceiver configurationReceiver)
                                                              throws OperationFailedException

Gets the notification session for subscribing to changes to configurations.

Parameters:

configurationReceiver - the notification callback

Returns:

a ConfigurationNotificationSession

Throws:

NullArgumentException - configurationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsConfigurationNotification()} is {@code true} .

getConfigurationHierarchySession

ConfigurationHierarchySession getConfigurationHierarchySession()
                                                        throws OperationFailedException

Gets a hierarchy traversal service for configurations.

Returns:

a ConfigurationHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsConfigurationHierarchy()} is {@code true} .

getConfigurationHierarchyDesignSession

ConfigurationHierarchyDesignSession getConfigurationHierarchyDesignSession()
                                                                    throws OperationFailedException

Gets a hierarchy design service for configurations.

Returns:

a ConfigurationHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsConfigurationHierarchyDesign()} is {@code true} .

getConfigurationBatchManager

ConfigurationBatchManager getConfigurationBatchManager()
                                                throws OperationFailedException

Gets a ConfigurationBatchManager .

Returns:

a ConfigurationBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsConfigurationBatch()} is {@code true} .

getConfigurationRulesManager

ConfigurationRulesManager getConfigurationRulesManager()
                                                throws OperationFailedException

Gets a ConfigurationRulesManager .

Returns:

a ConfigurationRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsConfigurationRules() is false

Compliance:

optional - This method must be implemented if {@code supportsConfigurationRules()} is {@code true} .