OSID - osid.configuration.ConfigurationManager Service Interface Definition

Interface	osid.configuration.ConfigurationManager
Implements	`osid.OsidManager`
Implements	`osid.configuration.ConfigurationProfile`
Description	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	getValueRetrievalSession
Description	Gets a configuration value retrieval session.
Return	`osid.configuration.ValueRetrievalSession`		a `ValueRetrievalSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsValueRetrieval()` is `false`
Compliance	`optional`		This method must be implemented if `supportsValueRetrieval()` is `true.`
Method	getValueRetrievalSessionForConfiguration
Description	Gets a configuration value retrieval session using the supplied configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ValueRetrievalSession`		a `ValueRetrievalSession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsValueRetrieval()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsValueRetrieval()` are `true.`
Method	getValueLookupSession
Description	Gets a configuration value lookup session.
Return	`osid.configuration.ValueLookupSession`		a `ValueLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsValueLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsValueLookup()` is `true.`
Method	getValueLookupSessionForConfiguration
Description	Gets a configuration value lookup session using the supplied configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ValueLookupSession`		a `ValueLookupSession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsValueLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsValueLookup()` are `true.`
Method	getValueQuerySession
Description	Gets a configuration value query session.
Return	`osid.configuration.ValueQuerySession`		a `ValueQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsValueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsValueQuery()` is `true.`
Method	getValueQuerySessionForConfiguration
Description	Gets a configuration value query session using the supplied configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ValueQuerySession`		a `ValueQuerySession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsValueQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsValueQuery()` are `true.`
Method	getValueSearchSession
Description	Gets a configuration value search session
Return	`osid.configuration.ValueSearchSession`		a `ValueSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsValueSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsValueSearch()` is `true.`
Method	getValueSearchSessionForConfiguration
Description	Gets a configuration value search session using the supplied configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ValueSearchSession`		a `ValueSearchSession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsValueSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsValueSearch()` are `true.`
Method	getValueAdminSession
Description	Gets a configuration value administration session.
Return	`osid.configuration.ValueAdminSession`		a `ValueAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsValueAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsValueAdmin()` is `true.`
Method	getValueAdminSessionForConfiguration
Description	Gets a value administration session using the supplied configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ValueAdminSession`		a `ValueAdminSession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		`supportsValueAdmin()` or `supportsVisibleFederation()` is `false`
	UNIMPLEMENTED		`supportsValueAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsValueAdmin()` are `true.`
Method	getValueNotificationSession
Description	Gets a value notification session.
Parameters	`osid.configuration.ValueReceiver`	`valueReceiver`	the notification callback
Return	`osid.configuration.ValueNotificationSession`		a `ValueNotificationSession`
Errors	NULL_ARGUMENT		`valueReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsValueNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsValueNotification()` is `true.`
Method	getValueNotificationSessionForConfiguration
Description	Gets a value notification session using the specified configuration
Parameters	`osid.configuration.ValueReceiver`	`valueReceiver`	the notification callback
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ValueNotificationSession`		a `ValueNotificationSession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`valueReceiver` or `configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsValueNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsValueNotification()` are `true.`
Method	getParameterLookupSession
Description	Gets a parameter lookup session
Return	`osid.configuration.ParameterLookupSession`		a `ParameterLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsParameterLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterLookup()` is `true.`
Method	getParameterLookupSessionForConfiguration
Description	Gets a parameter lookup session using the supplied configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ParameterLookupSession`		a `ParamaterLookupSession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsParameterLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsParameterLookup()` are `true.`
Method	getParameterQuerySession
Description	Gets a parameter query session
Return	`osid.configuration.ParameterQuerySession`		a `ParameterQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsParameterQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterQuery()` is `true.`
Method	getParameterQuerySessionForConfiguration
Description	Gets a parameter search session using the supplied configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ParameterQuerySession`		a `ParamaterQuerySession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsParameterQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsParameterQuery()` are `true.`
Method	getParameterSearchSession
Description	Gets a parameter search session
Return	`osid.configuration.ParameterSearchSession`		a `ParameterSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsParameterSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterSearch()` is `true.`
Method	getParameterSearchSessionForConfiguration
Description	Gets a parameter search session using the supplied configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ParameterSearchSession`		a `ParamaterSearchSession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsParameterSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsParameterSearch()` are `true.`
Method	getParameterAdminSession
Description	Gets a parameter administration session.
Return	`osid.configuration.ParameterAdminSession`		a `ParameterAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsParameterAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterAdmin()` is `true.`
Method	getParameterAdminSessionForConfiguration
Description	Gets a parameter administration session using the supplied configuration.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ParameterAdminSession`		a `ParameterAdminSession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsParameterSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsParameterAdmin()` are `true.`
Method	getParameterNotificationSession
Description	Gets a parameter notification session.
Parameters	`osid.configuration.ParameterReceiver`	`parameterReceiver`	the notification callback
Return	`osid.configuration.ParameterNotificationSession`		a `ParameterNotificationSession`
Errors	NULL_ARGUMENT		`parameterReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsParameterNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterNotification()` is `true.`
Method	getParameterNotificationSessionForConfiguration
Description	Gets a parameter notification session using the specified configuration.
Parameters	`osid.configuration.ParameterReceiver`	`parameterReceiver`	the notification callback
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ParameterNotificationSession`		a `ParameterNotificationSession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`parameterReceiver` or `configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsParameterNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVisibleFederation()` and `supportsParameterNotification()` are `true.`
Method	getParameterConfigurationSession
Description	Gets a session for looking up mappings of parameters to configurations.
Return	`osid.configuration.ParameterConfigurationSession`		a `ParameterConfigurationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsParameterConfiguration()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterConfiguration()` is `true.`
Method	getParameterConfigurationAssignmentSession
Description	Gets a session for managing mappings of parameters to configurations.
Return	`osid.configuration.ParameterConfigurationAssignmentSession`		a `ParameterConfigurationAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsParameterConfigurationAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterConfigurationAssignment()` is `true.`
Method	getParameterSmartConfigurationSession
Description	Gets a session for managing smart configurations.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to use
Return	`osid.configuration.ParameterSmartConfigurationSession`		a `ParameterSmartConfigurationSession`
Errors	NOT_FOUND		`configurationId` is not found
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsParameterSmartConfiguration()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterSmartConfiguration()` is `true.`
Method	getConfigurationLookupSession
Description	Gets a configuration lookup session.
Return	`osid.configuration.ConfigurationLookupSession`		a `ConfigurationLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsConfigurationLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConfigurationLookup()` is `true.`
Method	getConfigurationQuerySession
Description	Gets a configuration query session.
Return	`osid.configuration.ConfigurationQuerySession`		a `ConfigurationQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsConfigurationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConfigurationQuery()` is `true.`
Method	getConfigurationSearchSession
Description	Gets a configuration search session.
Return	`osid.configuration.ConfigurationSearchSession`		a `ConfigurationSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsConfigurationSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConfigurationSearch()` is `true.`
Method	getConfigurationAdminSession
Description	Gets a configuration administration session.
Return	`osid.configuration.ConfigurationAdminSession`		a `ConfigurationAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsConfigurationAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConfigurationAdmin()` is `true.`
Method	getConfigurationNotificationSession
Description	Gets the notification session for subscribing to changes to configurations.
Parameters	`osid.configuration.ConfigurationReceiver`	`configurationReceiver`	the notification callback
Return	`osid.configuration.ConfigurationNotificationSession`		a `ConfigurationNotificationSession`
Errors	NULL_ARGUMENT		`configurationReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsConfigurationNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConfigurationNotification()` is `true.`
Method	getConfigurationHierarchySession
Description	Gets a hierarchy traversal service for configurations.
Return	`osid.configuration.ConfigurationHierarchySession`		a `ConfigurationHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsConfigurationHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConfigurationHierarchy()` is `true.`
Method	getConfigurationHierarchyDesignSession
Description	Gets a hierarchy design service for configurations.
Return	`osid.configuration.ConfigurationHierarchyDesignSession`		a `ConfigurationHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsConfigurationHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConfigurationHierarchyDesign()` is `true.`
Method	getConfigurationBatchManager
Description	Gets a `ConfigurationBatchManager.`
Return	`osid.configuration.batch.ConfigurationBatchManager`		a `ConfigurationBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsConfigurationBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConfigurationBatch()` is `true.`
Method	getConfigurationRulesManager
Description	Gets a `ConfigurationRulesManager.`
Return	`osid.configuration.rules.ConfigurationRulesManager`		a `ConfigurationRulesManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsConfigurationRules()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConfigurationRules()` is `true.`