OSID Logo
OSID Specifications
configuration rules package
Version 3.1.0
Interfaceosid.configuration.rules.ConfigurationRulesManager
Implementsosid.OsidManager
osid.configuration.rules.ConfigurationRulesProfile
Used Byosid.configuration.ConfigurationManager
Description

The configuration rules manager provides access to configuration rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • ValueEnablerLookupSession: a session to retrieve value enablers
  • ValueEnablerQuerySession: a session to query for value enablers
  • ValueEnablerSearchSession: a session to search for value enablers
  • ValueEnablerAdminSession: a session to create and delete value enablers
  • ValueEnablerNotificationSession: a session to receive notifications pertaining to value enabler changes
  • ValueEnablerConfigurationSession: a session to look up value enabler configuration mappings
  • ValueEnablerConfigurationAssignmentSession: a session to manage value enabler to configuration mappings
  • ValueEnablerSmartConfigurationSession: a session to manage dynamic configurations of value enablers
  • ValuerEnablerRuleLookupSession: a session to look up value enabler mappings
  • ValueEnablerRuleApplicationSession: a session to apply value enablers
  • ParameterProcessorLookupSession: a session to retrieve parameter processor
  • ParameterProcessorQuerySession: a session to query for parameter processor
  • ParameterProcessorSearchSession: a session to search for parameter processor
  • ParameterProcessorAdminSession: a session to create and delete parameter processor
  • ParameterProcessorNotificationSession: a session to receive notifications pertaining to parameter processor changes
  • ParameterProcessorConfigurationSession: a session to look up parameter processor configuration mappings
  • ParameterProcessorConfigurationAssignmentSession : a session to manage parameter processor to configuration mappings
  • ParameterProcessorSmartConfigurationSession: a session to manage dynamic configurations of parameter processor
  • ParameterProcessorRuleLookupSession: a session to look up parameter processor to parameter mappings
  • ParameterProcessorRuleApplicationSession : a session to apply parameter processor to parameters
  • ParameterProcessorEnablerLookupSession: a session to retrieve parameter processor enablers
  • ParameterProcessorEnablerQuerySession: a session to query for parameter processor enablers
  • ParameterProcessorEnablerSearchSession: a session to search for parameter processor enablers
  • ParameterProcessorEnablerAdminSession: a session to create and delete parameter processor enablers
  • ParameterProcessorEnablerNotificationSession: a session to receive notifications pertaining to parameter processor enabler changes
  • ParameterProcessorEnablerConfigurationSession : a session to look up parameter processor enabler configuration mappings
  • ParameterProcessorEnablerConfigurationAssignmentSession : a session to manage parameter processor enabler to configuration mappings
  • ParameterProcessorEnablerSmartConfigurationSession : a session to manage dynamic configurations of parameter processor enablers
  • ParameterProcessorEnablerRuleLookupSession: a session to look up parameter processor enabler mappings
  • ParameterProcessorEnablerRuleApplicationSession : a session to apply parameter processor enablers
MethodgetValueEnablerLookupSession
Description

Gets the OsidSession associated with the value enabler lookup service.

Returnosid.configuration.rules.ValueEnablerLookupSession a ValueEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerLookup() is false
Complianceoptional This method must be implemented if supportsValueEnablerLookup() is true.
MethodgetValueEnablerLookupSessionForConfiguration
Description

Gets the OsidSession associated with the value enabler lookup service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ValueEnablerLookupSession a ValueEnablerLookupSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsValueEnablerLookup() and supportsVisibleFederation() are true.
MethodgetValueEnablerQuerySession
Description

Gets the OsidSession associated with the value enabler query service.

Returnosid.configuration.rules.ValueEnablerQuerySession a ValueEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerQuery() is false
Complianceoptional This method must be implemented if supportsValueEnablerQuery() is true.
MethodgetValueEnablerQuerySessionForConfiguration
Description

Gets the OsidSession associated with the value enabler query service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ValueEnablerQuerySession a ValueEnablerQuerySession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsValueEnablerQuery() and supportsVisibleFederation() are true.
MethodgetValueEnablerSearchSession
Description

Gets the OsidSession associated with the value enabler search service.

Returnosid.configuration.rules.ValueEnablerSearchSession a ValueEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerSearch() is false
Complianceoptional This method must be implemented if supportsValueEnablerSearch() is true.
MethodgetValueEnablerSearchSessionForConfiguration
Description

Gets the OsidSession associated with the value enablers earch service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ValueEnablerSearchSession a ValueEnablerSearchSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsValueEnablerSearch() and supportsVisibleFederation() are true.
MethodgetValueEnablerAdminSession
Description

Gets the OsidSession associated with the value enabler administration service.

Returnosid.configuration.rules.ValueEnablerAdminSession a ValueEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsValueEnablerAdmin() is true.
MethodgetValueEnablerAdminSessionForConfiguration
Description

Gets the OsidSession associated with the value enabler administration service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ValueEnablerAdminSession a ValueEnablerAdminSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsValueEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetValueEnablerNotificationSession
Description

Gets the OsidSession associated with the value enabler notification service.

Parametersosid.configuration.rules.ValueEnablerReceivervalueEnablerReceiver the notification callback
Returnosid.configuration.rules.ValueEnablerNotificationSession a ValueEnablerNotificationSession
ErrorsNULL_ARGUMENT valueEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerNotification() is false
Complianceoptional This method must be implemented if supportsValueEnablerNotification() is true.
MethodgetValueEnablerNotificationSessionForConfiguration
Description

Gets the OsidSession associated with the value enabler notification service for the given configuration.

Parametersosid.configuration.rules.ValueEnablerReceivervalueEnablerReceiver the notification callback
osid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ValueEnablerNotificationSession a ValueEnablerNotificationSession
ErrorsNOT_FOUND no configuration found by the given Id
NULL_ARGUMENT valueEnablerReceiver or configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsValueEnablerNotification() and supportsVisibleFederation() are true.
MethodgetValueEnablerConfigurationSession
Description

Gets the OsidSession to lookup value enabler/configuration mappings for value enablers.

Returnosid.configuration.rules.ValueEnablerConfigurationSession a ValueEnablerConfigurationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerConfiguration() is false
Complianceoptional This method must be implemented if supportsValueEnablerConfiguration() is true.
MethodgetValueEnablerConfigurationAssignmentSession
Description

Gets the OsidSession associated with assigning value enablers to configurations.

Returnosid.configuration.rules.ValueEnablerConfigurationAssignmentSession a ValueEnablerConfigurationAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerConfigurationAssignment() is false
Complianceoptional This method must be implemented if supportsValueEnablerConfigurationAssignment() is true.
MethodgetValueEnablerSmartConfigurationSession
Description

Gets the OsidSession to manage value enabler smart configurations.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ValueEnablerSmartConfigurationSession a ValueEnablerSmartConfigurationSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerSmartConfiguration() is false
Complianceoptional This method must be implemented if supportsValueEnablerSmartConfiguration() is true.
MethodgetValueEnablerRuleLookupSession
Description

Gets the OsidSession associated with the value enabler mapping lookup service.

Returnosid.configuration.rules.ValueEnablerRuleLookupSession a ValueEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsValueEnablerRuleLookup() is true.
MethodgetValueEnablerRuleLookupSessionForConfiguration
Description

Gets the OsidSession associated with the value enabler mapping lookup service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ValueEnablerRuleLookupSession a ValueEnablerRuleLookupSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerRuleLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsValueEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetValueEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the value enabler assignment service.

Returnosid.configuration.rules.ValueEnablerRuleApplicationSession a ValueEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsValueEnablerRuleApplication() is true.
MethodgetValueEnablerRuleApplicationSessionForConfiguration
Description

Gets the OsidSession associated with the value enabler assignment service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ValueEnablerRuleApplicationSession a ValueEnablerRuleApplicationSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsValueEnablerRuleApplication() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsValueEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetParameterProcessorLookupSession
Description

Gets the OsidSession associated with the parameter processor lookup service.

Returnosid.configuration.rules.ParameterProcessorLookupSession a ParameterProcessorLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorLookup() is false
Complianceoptional This method must be implemented if supportsParameterProcessorLookup() is true.
MethodgetParameterProcessorLookupSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor lookup service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorLookupSession a ParameterProcessorLookupSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorLookup() and supportsVisibleFederation() are true.
MethodgetParameterProcessorQuerySession
Description

Gets the OsidSession associated with the parameter processor query service.

Returnosid.configuration.rules.ParameterProcessorQuerySession a ParameterProcessorQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorQuery() is false
Complianceoptional This method must be implemented if supportsParameterProcessorQuery() is true.
MethodgetParameterProcessorQuerySessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor query service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorQuerySession a ParameterProcessorQuerySession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorQuery() and supportsVisibleFederation() are true.
MethodgetParameterProcessorSearchSession
Description

Gets the OsidSession associated with the parameter processor search service.

Returnosid.configuration.rules.ParameterProcessorSearchSession a ParameterProcessorSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorSearch() is false
Complianceoptional This method must be implemented if supportsParameterProcessorSearch() is true.
MethodgetParameterProcessorSearchSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor earch service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorSearchSession a ParameterProcessorSearchSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorSearch() and supportsVisibleFederation() are true.
MethodgetParameterProcessorAdminSession
Description

Gets the OsidSession associated with the parameter processor administration service.

Returnosid.configuration.rules.ParameterProcessorAdminSession a ParameterProcessorAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorAdmin() is false
Complianceoptional This method must be implemented if supportsParameterProcessorAdmin() is true.
MethodgetParameterProcessorAdminSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor administration service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorAdminSession a ParameterProcessorAdminSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorAdmin() and supportsVisibleFederation() are true.
MethodgetParameterProcessorNotificationSession
Description

Gets the OsidSession associated with the parameter processor notification service.

Parametersosid.configuration.rules.ParameterProcessorReceiverparameterProcessorReceiver the notification callback
Returnosid.configuration.rules.ParameterProcessorNotificationSession a ParameterProcessorNotificationSession
ErrorsNULL_ARGUMENT parameterProcessorReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorNotification() is false
Complianceoptional This method must be implemented if supportsParameterProcessorNotification() is true.
MethodgetParameterProcessorNotificationSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor notification service for the given configuration.

Parametersosid.configuration.rules.ParameterProcessorReceiverparameterProcessorReceiver the notification callback
osid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorNotificationSession a ParameterProcessorNotificationSession
ErrorsNOT_FOUND no configuration found by the given Id
NULL_ARGUMENT parameterProcessorReceiver or configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorNotification() and supportsVisibleFederation() are true.
MethodgetParameterProcessorConfigurationSession
Description

Gets the OsidSession to lookup parameter processor/configuration mappings for parameter processors.

Returnosid.configuration.rules.ParameterProcessorConfigurationSession a ParameterProcessorConfigurationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorConfiguration() is false
Complianceoptional This method must be implemented if supportsParameterProcessorConfiguration() is true.
MethodgetParameterProcessorConfigurationAssignmentSession
Description

Gets the OsidSession associated with assigning parameter processor to configurations.

Returnosid.configuration.rules.ParameterProcessorConfigurationAssignmentSession a ParameterProcessorConfigurationAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorConfigurationAssignment() is false
Complianceoptional This method must be implemented if supportsParameterProcessorConfigurationAssignment() is true.
MethodgetParameterProcessorSmartConfigurationSession
Description

Gets the OsidSession to manage parameter processor smart configurations.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorSmartConfigurationSession a ParameterProcessorSmartConfigurationSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorSmartConfiguration() is false
Complianceoptional This method must be implemented if supportsParameterProcessorSmartConfiguration() is true.
MethodgetParameterProcessorRuleLookupSession
Description

Gets the OsidSession associated with the parameter processor mapping lookup service for looking up the rules applied to the configuration.

Returnosid.configuration.rules.ParameterProcessorRuleLookupSession a ParameterProcessorRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorRuleLookup() is false
Complianceoptional This method must be implemented if supportsParameterProcessorRuleLookup() is true.
MethodgetParameterProcessorRuleLookupSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor mapping lookup service for the given configuration for looking up rules applied to an configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorRuleLookupSession a ParameterProcessorRuleLookupSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorRuleLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorRuleLookup() and supportsVisibleFederation() are true.
MethodgetParameterProcessorRuleApplicationSession
Description

Gets the OsidSession associated with the parameter processor assignment service.

Returnosid.configuration.rules.ParameterProcessorRuleApplicationSession a ParameterProcessorRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorRuleApplication() is false
Complianceoptional This method must be implemented if supportsParameterProcessorRuleApplication() is true.
MethodgetParameterProcessorRuleApplicationSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor assignment service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorRuleApplicationSession a ParameterProcessorRuleApplicationSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorRuleApplication() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorRuleApplication() and supportsVisibleFederation() are true.
MethodgetParameterProcessorEnablerLookupSession
Description

Gets the OsidSession associated with the parameter processor enabler lookup service.

Returnosid.configuration.rules.ParameterProcessorEnablerLookupSession a ParameterProcessorEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerLookup() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerLookup() is true.
MethodgetParameterProcessorEnablerLookupSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor enabler lookup service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerLookupSession a ParameterProcessorEnablerLookupSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerLookup() and supportsVisibleFederation() are true.
MethodgetParameterProcessorEnablerQuerySession
Description

Gets the OsidSession associated with the parameter processor enabler query service.

Returnosid.configuration.rules.ParameterProcessorEnablerQuerySession a ParameterProcessorEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerQuery() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerQuery() is true.
MethodgetParameterProcessorEnablerQuerySessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor enabler query service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerQuerySession a ParameterProcessorEnablerQuerySession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerQuery() and supportsVisibleFederation() are true.
MethodgetParameterProcessorEnablerSearchSession
Description

Gets the OsidSession associated with the parameter processor enabler search service.

Returnosid.configuration.rules.ParameterProcessorEnablerSearchSession a ParameterProcessorEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerSearch() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerSearch() is true.
MethodgetParameterProcessorEnablerSearchSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor enablers earch service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerSearchSession a ParameterProcessorEnablerSearchSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerSearch() and supportsVisibleFederation() are true.
MethodgetParameterProcessorEnablerAdminSession
Description

Gets the OsidSession associated with the parameter processor enabler administration service.

Returnosid.configuration.rules.ParameterProcessorEnablerAdminSession a ParameterProcessorEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerAdmin() is true.
MethodgetParameterProcessorEnablerAdminSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor enabler administration service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerAdminSession a ParameterProcessorEnablerAdminSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetParameterProcessorEnablerNotificationSession
Description

Gets the OsidSession associated with the parameter processor enabler notification service.

Parametersosid.configuration.rules.ParameterProcessorEnablerReceiverparameterProcessorEnablerReceiver the notification callback
Returnosid.configuration.rules.ParameterProcessorEnablerNotificationSession a ParameterProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENT parameterProcessorEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerNotification() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerNotification() is true.
MethodgetParameterProcessorEnablerNotificationSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor enabler notification service for the given configuration.

Parametersosid.configuration.rules.ParameterProcessorEnablerReceiverparameterProcessorEnablerReceiver the notification callback
osid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerNotificationSession a ParameterProcessorEnablerNotificationSession
ErrorsNOT_FOUND no configuration found by the given Id
NULL_ARGUMENT parameterProcessorEnablerReceiver or configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerNotification() and supportsVisibleFederation() are true.
MethodgetParameterProcessorEnablerConfigurationSession
Description

Gets the OsidSession to lookup parameter processor enabler/configuration mappings for parameter processor enablers.

Returnosid.configuration.rules.ParameterProcessorEnablerConfigurationSession a ParameterProcessorEnablerConfigurationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerConfiguration() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerConfiguration() is true.
MethodgetParameterProcessorEnablerConfigurationAssignmentSession
Description

Gets the OsidSession associated with assigning parameter processor enablers to configurations.

Returnosid.configuration.rules.ParameterProcessorEnablerConfigurationAssignmentSession a ParameterProcessorEnablerConfigurationAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerConfigurationAssignment() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerConfigurationAssignment() is true.
MethodgetParameterProcessorEnablerSmartConfigurationSession
Description

Gets the OsidSession to manage parameter processor enabler smart configurations.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerSmartConfigurationSession a ParameterProcessorEnablerSmartConfigurationSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerSmartConfiguration() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerSmartConfiguration() is true.
MethodgetParameterProcessorEnablerRuleLookupSession
Description

Gets the OsidSession associated with the parameter processor enabler mapping lookup service.

Returnosid.configuration.rules.ParameterProcessorEnablerRuleLookupSession a ParameterProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerRuleLookup() is true.
MethodgetParameterProcessorEnablerRuleLookupSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor enabler mapping lookup service.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerRuleLookupSession a ParameterProcessorEnablerRuleLookupSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetParameterProcessorEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the parameter processor enabler assignment service.

Returnosid.configuration.rules.ParameterProcessorEnablerRuleApplicationSession a ParameterProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerRuleApplication() is true.
MethodgetParameterProcessorEnablerRuleApplicationSessionForConfiguration
Description

Gets the OsidSession associated with the parameter processor enabler assignment service for the given configuration.

Parametersosid.id.IdconfigurationId the Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerRuleApplicationSession a ParameterProcessorEnablerRuleApplicationSession
ErrorsNOT_FOUND no Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParameterProcessorEnablerRuleApplication() and supportsVisibleFederation() are true.