Interface RulesProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
RulesManager, RulesProxyManager
public interface RulesProfile extends OsidProfile

The rules profile describes the interoperability among rule services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any engine federation is exposed. Federation is exposed when a specific engine may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of engines appears as a single engine.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleEvaluation

      boolean supportsRuleEvaluation()
      Tests if rule evaluation is supported.
      Returns:
      true if rule evaluation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleLookup

      boolean supportsRuleLookup()
      Tests for the availability of a rule lookup service.
      Returns:
      true if rule lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleQuery

      boolean supportsRuleQuery()
      Tests if querying rules is available.
      Returns:
      true if rule query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleSearch

      boolean supportsRuleSearch()
      Tests if searching for rules is available.
      Returns:
      true if rule search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleAdmin

      boolean supportsRuleAdmin()
      Tests if managing rules is available.
      Returns:
      true if rule admin is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleNotification

      boolean supportsRuleNotification()
      Tests if rule notification is available.
      Returns:
      true if rule notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleEngine

      boolean supportsRuleEngine()
      Tests if rule cataloging is available.
      Returns:
      true if rule cataloging is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleEngineAssignment

      boolean supportsRuleEngineAssignment()
      Tests if a rule cataloging assignment service is supported. A rule cataloging service maps rules to engines.
      Returns:
      true if rule cataloging is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleSmartEngine

      boolean supportsRuleSmartEngine()
      Tests if rule smart engines is available.
      Returns:
      true if rule smart engines is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEngineLookup

      boolean supportsEngineLookup()
      Tests for the availability of an engine lookup service.
      Returns:
      true if engine lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEngineQuery

      boolean supportsEngineQuery()
      Tests for the availability of an engine query service.
      Returns:
      true if engine query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEngineSearch

      boolean supportsEngineSearch()
      Tests if searching for engines is available.
      Returns:
      true if engine search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEngineAdmin

      boolean supportsEngineAdmin()
      Tests for the availability of an engine administrative service for creating and deleting engines.
      Returns:
      true if engine administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEngineNotification

      boolean supportsEngineNotification()
      Tests for the availability of an engine notification service.
      Returns:
      true if engine notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsEngineHierarchy

      boolean supportsEngineHierarchy()
      Tests for the availability of an engine hierarchy traversal service.
      Returns:
      true if engine hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEngineHierarchyDesign

      boolean supportsEngineHierarchyDesign()
      Tests for the availability of an engine hierarchy design service.
      Returns:
      true if engine hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsRulesCheck

      boolean supportsRulesCheck()
      Tests for the availability of a rules check service.
      Returns:
      true if a rules check service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • getRuleRecordTypes

      TypeList getRuleRecordTypes()
      Gets the supported Rule record types.
      Returns:
      a list containing the supported rule record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleRecordType

      boolean supportsRuleRecordType(Type ruleRecordType)
      Tests if the given Rule record type is supported.
      Parameters:
      ruleRecordType - a Type indicating a Rule record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - ruleRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getRuleSearchRecordTypes

      TypeList getRuleSearchRecordTypes()
      Gets the supported rule search record types.
      Returns:
      a list containing the supported rule search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRuleSearchRecordType

      boolean supportsRuleSearchRecordType(Type ruleSearchRecordType)
      Tests if the given rule search record type is supported.
      Parameters:
      ruleSearchRecordType - a Type indicating a rule record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - ruleSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getEngineRecordTypes

      TypeList getEngineRecordTypes()
      Gets the supported Engine record types.
      Returns:
      a list containing the supported engine record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsEngineRecordType

      boolean supportsEngineRecordType(Type engineRecordType)
      Tests if the given Engine record type is supported.
      Parameters:
      engineRecordType - a Type indicating an Engine record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - engineRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getEngineSearchRecordTypes

      TypeList getEngineSearchRecordTypes()
      Gets the supported engine search record types.
      Returns:
      a list containing the supported engine search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsEngineSearchRecordType

      boolean supportsEngineSearchRecordType(Type engineSearchRecordType)
      Tests if the given engine search record type is supported.
      Parameters:
      engineSearchRecordType - a Type indicating an engine record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - engineSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.