OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ConfigurationRulesManager
Implementsosid.OsidManager
osid.configuration.rules.ConfigurationRulesProfile
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.ValueEnablerLookupSessiona ValueEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerLookup() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ValueEnablerLookupSessiona ValueEnablerLookupSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ValueEnablerQuerySessiona ValueEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerQuery() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ValueEnablerQuerySessiona ValueEnablerQuerySession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ValueEnablerSearchSessiona ValueEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerSearch() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ValueEnablerSearchSessiona ValueEnablerSearchSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ValueEnablerAdminSessiona ValueEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerAdmin() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ValueEnablerAdminSessiona ValueEnablerAdminSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ValueEnablerReceivervalueEnablerReceiverthe notification callback
Returnosid.configuration.rules.ValueEnablerNotificationSessiona ValueEnablerNotificationSession
ErrorsNULL_ARGUMENT valueEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerNotification() is false
ComplianceoptionalThis 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.ValueEnablerReceivervalueEnablerReceiverthe notification callback
osid.id.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ValueEnablerNotificationSessiona ValueEnablerNotificationSession
ErrorsNOT_FOUNDno configuration found by the given Id
NULL_ARGUMENT valueEnablerReceiver or configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ValueEnablerConfigurationSessiona ValueEnablerConfigurationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerConfiguration() is false
ComplianceoptionalThis method must be implemented if supportsValueEnablerConfiguration() is true.
MethodgetValueEnablerConfigurationAssignmentSession
Description

Gets the OsidSession associated with assigning value enablers to configurations.

Returnosid.configuration.rules.ValueEnablerConfigurationAssignmentSessiona ValueEnablerConfigurationAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerConfigurationAssignment() is false
ComplianceoptionalThis method must be implemented if supportsValueEnablerConfigurationAssignment() is true.
MethodgetValueEnablerSmartConfigurationSession
Description

Gets the OsidSession to manage value enabler smart configurations.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ValueEnablerSmartConfigurationSessiona ValueEnablerSmartConfigurationSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerSmartConfiguration() is false
ComplianceoptionalThis method must be implemented if supportsValueEnablerSmartConfiguration() is true.
MethodgetValueEnablerRuleLookupSession
Description

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

Returnosid.configuration.rules.ValueEnablerRuleLookupSessiona ValueEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerRuleLookup() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ValueEnablerRuleLookupSessiona ValueEnablerRuleLookupSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ValueEnablerRuleApplicationSessiona ValueEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerRuleApplication() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ValueEnablerRuleApplicationSessiona ValueEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsValueEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorLookupSessiona ParameterProcessorLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorLookup() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorLookupSessiona ParameterProcessorLookupSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorQuerySessiona ParameterProcessorQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorQuery() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorQuerySessiona ParameterProcessorQuerySession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorSearchSessiona ParameterProcessorSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorSearch() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorSearchSessiona ParameterProcessorSearchSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorAdminSessiona ParameterProcessorAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorAdmin() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorAdminSessiona ParameterProcessorAdminSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorReceiverparameterProcessorReceiverthe notification callback
Returnosid.configuration.rules.ParameterProcessorNotificationSessiona ParameterProcessorNotificationSession
ErrorsNULL_ARGUMENT parameterProcessorReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorNotification() is false
ComplianceoptionalThis 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.ParameterProcessorReceiverparameterProcessorReceiverthe notification callback
osid.id.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorNotificationSessiona ParameterProcessorNotificationSession
ErrorsNOT_FOUNDno configuration found by the given Id
NULL_ARGUMENT parameterProcessorReceiver or configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorConfigurationSessiona ParameterProcessorConfigurationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorConfiguration() is false
ComplianceoptionalThis method must be implemented if supportsParameterProcessorConfiguration() is true.
MethodgetParameterProcessorConfigurationAssignmentSession
Description

Gets the OsidSession associated with assigning parameter processor to configurations.

Returnosid.configuration.rules.ParameterProcessorConfigurationAssignmentSessiona ParameterProcessorConfigurationAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorConfigurationAssignment() is false
ComplianceoptionalThis method must be implemented if supportsParameterProcessorConfigurationAssignment() is true.
MethodgetParameterProcessorSmartConfigurationSession
Description

Gets the OsidSession to manage parameter processor smart configurations.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorSmartConfigurationSessiona ParameterProcessorSmartConfigurationSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorSmartConfiguration() is false
ComplianceoptionalThis 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.ParameterProcessorRuleLookupSessiona ParameterProcessorRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorRuleLookup() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorRuleLookupSessiona ParameterProcessorRuleLookupSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorRuleApplicationSessiona ParameterProcessorRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorRuleApplication() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorRuleApplicationSessiona ParameterProcessorRuleApplicationSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorEnablerLookupSessiona ParameterProcessorEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerLookup() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerLookupSessiona ParameterProcessorEnablerLookupSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorEnablerQuerySessiona ParameterProcessorEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerQuery() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerQuerySessiona ParameterProcessorEnablerQuerySession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorEnablerSearchSessiona ParameterProcessorEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerSearch() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerSearchSessiona ParameterProcessorEnablerSearchSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorEnablerAdminSessiona ParameterProcessorEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerAdmin() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerAdminSessiona ParameterProcessorEnablerAdminSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorEnablerReceiverparameterProcessorEnablerReceiverthe notification callback
Returnosid.configuration.rules.ParameterProcessorEnablerNotificationSessiona ParameterProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENT parameterProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerNotification() is false
ComplianceoptionalThis 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.ParameterProcessorEnablerReceiverparameterProcessorEnablerReceiverthe notification callback
osid.id.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerNotificationSessiona ParameterProcessorEnablerNotificationSession
ErrorsNOT_FOUNDno configuration found by the given Id
NULL_ARGUMENT parameterProcessorEnablerReceiver or configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorEnablerConfigurationSessiona ParameterProcessorEnablerConfigurationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerConfiguration() is false
ComplianceoptionalThis method must be implemented if supportsParameterProcessorEnablerConfiguration() is true.
MethodgetParameterProcessorEnablerConfigurationAssignmentSession
Description

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

Returnosid.configuration.rules.ParameterProcessorEnablerConfigurationAssignmentSessiona ParameterProcessorEnablerConfigurationAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerConfigurationAssignment() is false
ComplianceoptionalThis method must be implemented if supportsParameterProcessorEnablerConfigurationAssignment() is true.
MethodgetParameterProcessorEnablerSmartConfigurationSession
Description

Gets the OsidSession to manage parameter processor enabler smart configurations.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerSmartConfigurationSessiona ParameterProcessorEnablerSmartConfigurationSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerSmartConfiguration() is false
ComplianceoptionalThis 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.ParameterProcessorEnablerRuleLookupSessiona ParameterProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsParameterProcessorEnablerRuleLookup() is true.
MethodgetParameterProcessorEnablerRuleLookupSessionForConfiguration
Description

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

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerRuleLookupSessiona ParameterProcessorEnablerRuleLookupSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.ParameterProcessorEnablerRuleApplicationSessiona ParameterProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerRuleApplication() is false
ComplianceoptionalThis 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.IdconfigurationIdthe Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerRuleApplicationSessiona ParameterProcessorEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Configuration found by the given Id
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParameterProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsParameterProcessorEnablerRuleApplication() and supportsVisibleFederation() are true.