OSID - osid.configuration.ConfigurationProfile Service Interface Definition

Interface	osid.configuration.ConfigurationProfile
Implements	`osid.OsidProfile`
Description	The `ConfigurationProfile` describes the profile of the configuration service.
Method	supportsVisibleFederation
Description	Tests if federation is visible for this service.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsValueRetrieval
Description	Tests for the availability of a configuration value retrieval service.
Return	`boolean`		`true` if value retrieval is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsValueLookup
Description	Tests for the availability of a configuration value lookup service.
Return	`boolean`		`true` if value lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsValueQuery
Description	Tests for the availability of a configuration value query service.
Return	`boolean`		`true` if value query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsValueSearch
Description	Tests for the availability of a configuration value search service.
Return	`boolean`		`true` if value search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsValueAdmin
Description	Tests for the availability of a configuration value administration service.
Return	`boolean`		`true` if value administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsValueNotification
Description	Tests for the availability of a configuration value notification service.
Return	`boolean`		`true` if value notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterLookup
Description	Tests for the availability of a parameter lookup service.
Return	`boolean`		`true` if parameter lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterQuery
Description	Tests for the availability of a parameter query service.
Return	`boolean`		`true` if parameter query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterSearch
Description	Tests for the availability of a parameter search service.
Return	`boolean`		`true` if parameter search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterAdmin
Description	Tests for the availability of a parameter update service.
Return	`boolean`		`true` if parameter update is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsParameterNotification
Description	Tests for the availability of a parameter notification service.
Return	`boolean`		`true` if parameter notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterConfiguration
Description	Tests for the availability of a service to lookup mappings of parameters to configurations.
Return	`boolean`		`true` if parameter configuration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsParameterConfigurationAssignment
Description	Tests for the availability of a service to map parameters to configurations.
Return	`boolean`		`true` if parameter configuration assignment is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsParameterSmartConfiguration
Description	Tests for the availability of a parameter smart configuration service.
Return	`boolean`		`true` if parameter smart configuration service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsConfigurationLookup
Description	Tests for the availability of a configuration lookup service.
Return	`boolean`		`true` if configuration lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationQuery
Description	Tests for the availability of a configuration query service.
Return	`boolean`		`true` if configuration query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationSearch
Description	Tests for the availability of a configuration search service.
Return	`boolean`		`true` if configuration search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationAdmin
Description	Tests for the availability of a configuration admin service.
Return	`boolean`		`true` if configuration admin is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationNotification
Description	Tests for the availability of a notification service for subscribing to changes to configurations.
Return	`boolean`		`true` if a configuration notification service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationHierarchy
Description	Tests for the availability of a configuration hierarchy traversal service.
Return	`boolean`		`true` if a configuration hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationHierarchyDesign
Description	Tests for the availability of a configuration hierarchy design service.
Return	`boolean`		`true` if a configuration hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationBatch
Description	Tests for the availability of a configuration batch service.
Return	`boolean`		`true` if a configuration batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationRules
Description	Tests for the availability of a configuration rules service.
Return	`boolean`		`true` if a configuration rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getValueConditionRecordTypes
Description	Gets the supported value condition record types.
Return	`osid.type.TypeList`		a list containing the supported `ValueCondition` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsValueConditionRecordType
Description	Tests if the given `ValueCondition` record type is supported.
Parameters	`osid.type.Type`	`valueConditionRecordType`	a `Type` indicating a `ValueCondition` record type
Return	`boolean`		`true` if the given value condition record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`valueConditionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getValueRecordTypes
Description	Gets all the value record types supported.
Return	`osid.type.TypeList`		the list of supported value record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsValueRecordType
Description	Tests if a given value record type is supported.
Parameters	`osid.type.Type`	`valueRecordType`	the value record type
Return	`boolean`		`true` if the value record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`valueRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getValueSearchRecordTypes
Description	Gets all the value search record types supported.
Return	`osid.type.TypeList`		the list of supported value search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsValueSearchRecordType
Description	Tests if a given value search type is supported.
Parameters	`osid.type.Type`	`valueSearchRecordType`	the value search record type
Return	`boolean`		`true` if the value search record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`valueSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getParameterRecordTypes
Description	Gets all the parameter record types supported.
Return	`osid.type.TypeList`		the list of supported parameter record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterRecordType
Description	Tests if a given parameter record type is supported.
Parameters	`osid.type.Type`	`parameterRecordType`	a parameter record type
Return	`boolean`		`true` if the parameter record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`parameterRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getParameterSearchRecordTypes
Description	Gets all the parameter search record types supported.
Return	`osid.type.TypeList`		the list of supported parameter search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterSearchRecordType
Description	Tests if a given parameter search record type is supported.
Parameters	`osid.type.Type`	`parameterSearchRecordType`	the value search type
Return	`boolean`		`true` if the parameter search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`parameterSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getConfigurationRecordTypes
Description	Gets all the configuration record types supported.
Return	`osid.type.TypeList`		the list of supported configuration record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationRecordType
Description	Tests if a given configuration record type is supported.
Parameters	`osid.type.Type`	`configurationRecordType`	a configuration record type
Return	`boolean`		`true` if the configuration record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`configurationRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getConfigurationSearchRecordTypes
Description	Gets all the configuration search record types supported.
Return	`osid.type.TypeList`		the list of supported configuration search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsConfigurationSearchRecordType
Description	Tests if a given configuration search record type is supported.
Parameters	`osid.type.Type`	`configurationSearchRecordType`	the configuration search record type
Return	`boolean`		`true` if the configuration search record type is support `e` d, `false` otherwise
Errors	NULL_ARGUMENT		`configurationSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.