Interface ConfigurationRulesManager

All Superinterfaces:
AutoCloseable, Closeable, ConfigurationRulesProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface ConfigurationRulesManager extends OsidManager, ConfigurationRulesProfile

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

  • Method Details

    • getValueEnablerLookupSession

      ValueEnablerLookupSession getValueEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the value enabler lookup service.
      Returns:
      a ValueEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerLookup()} is {@code true} .

    • getValueEnablerLookupSessionForConfiguration

      ValueEnablerLookupSession getValueEnablerLookupSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the value enabler lookup service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ValueEnablerLookupSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getValueEnablerQuerySession

      ValueEnablerQuerySession getValueEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the value enabler query service.
      Returns:
      a ValueEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerQuery()} is {@code true} .

    • getValueEnablerQuerySessionForConfiguration

      ValueEnablerQuerySession getValueEnablerQuerySessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the value enabler query service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ValueEnablerQuerySession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getValueEnablerSearchSession

      ValueEnablerSearchSession getValueEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the value enabler search service.
      Returns:
      a ValueEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerSearch()} is {@code true} .

    • getValueEnablerSearchSessionForConfiguration

      ValueEnablerSearchSession getValueEnablerSearchSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the value enablers earch service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ValueEnablerSearchSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getValueEnablerAdminSession

      ValueEnablerAdminSession getValueEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the value enabler administration service.
      Returns:
      a ValueEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerAdmin()} is {@code true} .

    • getValueEnablerAdminSessionForConfiguration

      ValueEnablerAdminSession getValueEnablerAdminSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the value enabler administration service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ValueEnablerAdminSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getValueEnablerNotificationSession

      ValueEnablerNotificationSession getValueEnablerNotificationSession(ValueEnablerReceiver valueEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the value enabler notification service.
      Parameters:
      valueEnablerReceiver - the notification callback
      Returns:
      a ValueEnablerNotificationSession
      Throws:
      NullArgumentException - valueEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerNotification()} is {@code true} .

    • getValueEnablerNotificationSessionForConfiguration

      ValueEnablerNotificationSession getValueEnablerNotificationSessionForConfiguration(ValueEnablerReceiver valueEnablerReceiver, Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the value enabler notification service for the given configuration.
      Parameters:
      valueEnablerReceiver - the notification callback
      configurationId - the Id of the Configuration
      Returns:
      a ValueEnablerNotificationSession
      Throws:
      NotFoundException - no configuration found by the given Id
      NullArgumentException - valueEnablerReceiver or configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getValueEnablerConfigurationSession

      ValueEnablerConfigurationSession getValueEnablerConfigurationSession() throws OperationFailedException
      Gets the OsidSession to lookup value enabler/configuration mappings for value enablers.
      Returns:
      a ValueEnablerConfigurationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerConfiguration() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerConfiguration()} is {@code true} .

    • getValueEnablerConfigurationAssignmentSession

      ValueEnablerConfigurationAssignmentSession getValueEnablerConfigurationAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning value enablers to configurations.
      Returns:
      a ValueEnablerConfigurationAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerConfigurationAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerConfigurationAssignment()} is {@code true} .

    • getValueEnablerSmartConfigurationSession

      ValueEnablerSmartConfigurationSession getValueEnablerSmartConfigurationSession(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage value enabler smart configurations.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ValueEnablerSmartConfigurationSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerSmartConfiguration() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerSmartConfiguration()} is {@code true} .

    • getValueEnablerRuleLookupSession

      ValueEnablerRuleLookupSession getValueEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the value enabler mapping lookup service.
      Returns:
      a ValueEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerRuleLookup()} is {@code true} .

    • getValueEnablerRuleLookupSessionForConfiguration

      ValueEnablerRuleLookupSession getValueEnablerRuleLookupSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the value enabler mapping lookup service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ValueEnablerRuleLookupSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getValueEnablerRuleApplicationSession

      ValueEnablerRuleApplicationSession getValueEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the value enabler assignment service.
      Returns:
      a ValueEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerRuleApplication()} is {@code true} .

    • getValueEnablerRuleApplicationSessionForConfiguration

      ValueEnablerRuleApplicationSession getValueEnablerRuleApplicationSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the value enabler assignment service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ValueEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsValueEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsValueEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorLookupSession

      ParameterProcessorLookupSession getParameterProcessorLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor lookup service.
      Returns:
      a ParameterProcessorLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorLookup()} is {@code true} .

    • getParameterProcessorLookupSessionForConfiguration

      ParameterProcessorLookupSession getParameterProcessorLookupSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor lookup service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorLookupSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorQuerySession

      ParameterProcessorQuerySession getParameterProcessorQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor query service.
      Returns:
      a ParameterProcessorQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorQuery()} is {@code true} .

    • getParameterProcessorQuerySessionForConfiguration

      ParameterProcessorQuerySession getParameterProcessorQuerySessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor query service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorQuerySession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorSearchSession

      ParameterProcessorSearchSession getParameterProcessorSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor search service.
      Returns:
      a ParameterProcessorSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorSearch()} is {@code true} .

    • getParameterProcessorSearchSessionForConfiguration

      ParameterProcessorSearchSession getParameterProcessorSearchSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor earch service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorSearchSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorAdminSession

      ParameterProcessorAdminSession getParameterProcessorAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor administration service.
      Returns:
      a ParameterProcessorAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorAdmin()} is {@code true} .

    • getParameterProcessorAdminSessionForConfiguration

      ParameterProcessorAdminSession getParameterProcessorAdminSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor administration service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorAdminSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorNotificationSession

      ParameterProcessorNotificationSession getParameterProcessorNotificationSession(ParameterProcessorReceiver parameterProcessorReceiver) throws OperationFailedException
      Gets the OsidSession associated with the parameter processor notification service.
      Parameters:
      parameterProcessorReceiver - the notification callback
      Returns:
      a ParameterProcessorNotificationSession
      Throws:
      NullArgumentException - parameterProcessorReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorNotification()} is {@code true} .

    • getParameterProcessorNotificationSessionForConfiguration

      ParameterProcessorNotificationSession getParameterProcessorNotificationSessionForConfiguration(ParameterProcessorReceiver parameterProcessorReceiver, Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor notification service for the given configuration.
      Parameters:
      parameterProcessorReceiver - the notification callback
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorNotificationSession
      Throws:
      NotFoundException - no configuration found by the given Id
      NullArgumentException - parameterProcessorReceiver or configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorConfigurationSession

      ParameterProcessorConfigurationSession getParameterProcessorConfigurationSession() throws OperationFailedException
      Gets the OsidSession to lookup parameter processor/configuration mappings for parameter processors.
      Returns:
      a ParameterProcessorConfigurationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorConfiguration() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorConfiguration()} is {@code true} .

    • getParameterProcessorConfigurationAssignmentSession

      ParameterProcessorConfigurationAssignmentSession getParameterProcessorConfigurationAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning parameter processor to configurations.
      Returns:
      a ParameterProcessorConfigurationAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorConfigurationAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorConfigurationAssignment()} is {@code true} .

    • getParameterProcessorSmartConfigurationSession

      ParameterProcessorSmartConfigurationSession getParameterProcessorSmartConfigurationSession(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage parameter processor smart configurations.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorSmartConfigurationSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorSmartConfiguration() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorSmartConfiguration()} is {@code true} .

    • getParameterProcessorRuleLookupSession

      ParameterProcessorRuleLookupSession getParameterProcessorRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor mapping lookup service for looking up the rules applied to the configuration.
      Returns:
      a ParameterProcessorRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorRuleLookup()} is {@code true} .

    • getParameterProcessorRuleLookupSessionForConfiguration

      ParameterProcessorRuleLookupSession getParameterProcessorRuleLookupSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor mapping lookup service for the given configuration for looking up rules applied to an configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorRuleLookupSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorRuleApplicationSession

      ParameterProcessorRuleApplicationSession getParameterProcessorRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor assignment service.
      Returns:
      a ParameterProcessorRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorRuleApplication()} is {@code true} .

    • getParameterProcessorRuleApplicationSessionForConfiguration

      ParameterProcessorRuleApplicationSession getParameterProcessorRuleApplicationSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor assignment service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorRuleApplicationSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorEnablerLookupSession

      ParameterProcessorEnablerLookupSession getParameterProcessorEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler lookup service.
      Returns:
      a ParameterProcessorEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerLookup()} is {@code true} .

    • getParameterProcessorEnablerLookupSessionForConfiguration

      ParameterProcessorEnablerLookupSession getParameterProcessorEnablerLookupSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler lookup service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorEnablerLookupSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorEnablerQuerySession

      ParameterProcessorEnablerQuerySession getParameterProcessorEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler query service.
      Returns:
      a ParameterProcessorEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerQuery()} is {@code true} .

    • getParameterProcessorEnablerQuerySessionForConfiguration

      ParameterProcessorEnablerQuerySession getParameterProcessorEnablerQuerySessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler query service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorEnablerQuerySession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorEnablerSearchSession

      ParameterProcessorEnablerSearchSession getParameterProcessorEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler search service.
      Returns:
      a ParameterProcessorEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerSearch()} is {@code true} .

    • getParameterProcessorEnablerSearchSessionForConfiguration

      ParameterProcessorEnablerSearchSession getParameterProcessorEnablerSearchSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor enablers earch service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorEnablerSearchSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorEnablerAdminSession

      ParameterProcessorEnablerAdminSession getParameterProcessorEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler administration service.
      Returns:
      a ParameterProcessorEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerAdmin()} is {@code true} .

    • getParameterProcessorEnablerAdminSessionForConfiguration

      ParameterProcessorEnablerAdminSession getParameterProcessorEnablerAdminSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler administration service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorEnablerAdminSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorEnablerNotificationSession

      ParameterProcessorEnablerNotificationSession getParameterProcessorEnablerNotificationSession(ParameterProcessorEnablerReceiver parameterProcessorEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler notification service.
      Parameters:
      parameterProcessorEnablerReceiver - the notification callback
      Returns:
      a ParameterProcessorEnablerNotificationSession
      Throws:
      NullArgumentException - parameterProcessorEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerNotification()} is {@code true} .

    • getParameterProcessorEnablerNotificationSessionForConfiguration

      ParameterProcessorEnablerNotificationSession getParameterProcessorEnablerNotificationSessionForConfiguration(ParameterProcessorEnablerReceiver parameterProcessorEnablerReceiver, Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler notification service for the given configuration.
      Parameters:
      parameterProcessorEnablerReceiver - the notification callback
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorEnablerNotificationSession
      Throws:
      NotFoundException - no configuration found by the given Id
      NullArgumentException - parameterProcessorEnablerReceiver or configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorEnablerConfigurationSession

      ParameterProcessorEnablerConfigurationSession getParameterProcessorEnablerConfigurationSession() throws OperationFailedException
      Gets the OsidSession to lookup parameter processor enabler/configuration mappings for parameter processor enablers.
      Returns:
      a ParameterProcessorEnablerConfigurationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerConfiguration() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerConfiguration()} is {@code true} .

    • getParameterProcessorEnablerConfigurationAssignmentSession

      ParameterProcessorEnablerConfigurationAssignmentSession getParameterProcessorEnablerConfigurationAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning parameter processor enablers to configurations.
      Returns:
      a ParameterProcessorEnablerConfigurationAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerConfigurationAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerConfigurationAssignment()} is {@code true} .

    • getParameterProcessorEnablerSmartConfigurationSession

      ParameterProcessorEnablerSmartConfigurationSession getParameterProcessorEnablerSmartConfigurationSession(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage parameter processor enabler smart configurations.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorEnablerSmartConfigurationSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerSmartConfiguration() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerSmartConfiguration()} is {@code true} .

    • getParameterProcessorEnablerRuleLookupSession

      ParameterProcessorEnablerRuleLookupSession getParameterProcessorEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler mapping lookup service.
      Returns:
      a ParameterProcessorEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerRuleLookup()} is {@code true} .

    • getParameterProcessorEnablerRuleLookupSessionForConfiguration

      ParameterProcessorEnablerRuleLookupSession getParameterProcessorEnablerRuleLookupSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler mapping lookup service.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorEnablerRuleLookupSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getParameterProcessorEnablerRuleApplicationSession

      ParameterProcessorEnablerRuleApplicationSession getParameterProcessorEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler assignment service.
      Returns:
      a ParameterProcessorEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerRuleApplication()} is {@code true} .

    • getParameterProcessorEnablerRuleApplicationSessionForConfiguration

      ParameterProcessorEnablerRuleApplicationSession getParameterProcessorEnablerRuleApplicationSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the parameter processor enabler assignment service for the given configuration.
      Parameters:
      configurationId - the Id of the Configuration
      Returns:
      a ParameterProcessorEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Configuration found by the given Id
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsParameterProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParameterProcessorEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .