Interface RulesCheckProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
RulesCheckManager, RulesCheckProxyManager

public interface RulesCheckProfile extends OsidProfile

The rules check profile describes the interoperability among rules check 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.
    • supportsAgenda

      boolean supportsAgenda()
      Tests if an agenda evaluation service is supported.
      Returns:
      true if an agenda evaluation service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaEvaluation

      boolean supportsAgendaEvaluation()
      Tests if an agenda evaluation service with detailed results is supported.
      Returns:
      true if an agenda evaluation service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaLookup

      boolean supportsAgendaLookup()
      Tests if looking up agendas is supported.
      Returns:
      true if agenda lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaQuery

      boolean supportsAgendaQuery()
      Tests if querying agendas is supported.
      Returns:
      true if agenda query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaSearch

      boolean supportsAgendaSearch()
      Tests if searching agendas is supported.
      Returns:
      true if agenda search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaAdmin

      boolean supportsAgendaAdmin()
      Tests if agenda administrative service is supported.
      Returns:
      true if agenda administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaNotification

      boolean supportsAgendaNotification()
      Tests if an agenda notification service is supported.
      Returns:
      true if agenda notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaEngine

      boolean supportsAgendaEngine()
      Tests if an agenda engine lookup service is supported.
      Returns:
      true if an agenda engine lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaEngineAssignment

      boolean supportsAgendaEngineAssignment()
      Tests if an agenda engine service is supported.
      Returns:
      true if agenda to engine assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaSmartEngine

      boolean supportsAgendaSmartEngine()
      Tests if an agenda smart engine lookup service is supported.
      Returns:
      true if an agenda smart engine service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionApplicability

      boolean supportsInstructionApplicability()
      Tests if evaluating instruction applicability is supported.
      Returns:
      true if instruction evaluation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionLookup

      boolean supportsInstructionLookup()
      Tests if looking up instructions is supported.
      Returns:
      true if instruction lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionQuery

      boolean supportsInstructionQuery()
      Tests if querying instructions is supported.
      Returns:
      true if instruction query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionSearch

      boolean supportsInstructionSearch()
      Tests if searching instructions is supported.
      Returns:
      true if instruction search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionAdmin

      boolean supportsInstructionAdmin()
      Tests if instruction administrative service is supported.
      Returns:
      true if instruction administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionNotification

      boolean supportsInstructionNotification()
      Tests if an instruction notification service is supported.
      Returns:
      true if instruction notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionEngine

      boolean supportsInstructionEngine()
      Tests if an instruction engine lookup service is supported.
      Returns:
      true if an instruction engine lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionEngineAssignment

      boolean supportsInstructionEngineAssignment()
      Tests if an instruction engine assignment service is supported.
      Returns:
      true if an instruction to engine assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionSmartEngine

      boolean supportsInstructionSmartEngine()
      Tests if an instruction smart engine service is supported.
      Returns:
      true if an instruction smart engine service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckEvaluation

      boolean supportsCheckEvaluation()
      Tests if evaluating checks is supported.
      Returns:
      true if check evaluation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckLookup

      boolean supportsCheckLookup()
      Tests if looking up checks is supported.
      Returns:
      true if check lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckQuery

      boolean supportsCheckQuery()
      Tests if querying checks is supported.
      Returns:
      true if check query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckSearch

      boolean supportsCheckSearch()
      Tests if searching checks is supported.
      Returns:
      true if check search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckAdmin

      boolean supportsCheckAdmin()
      Tests if check administrative service is supported.
      Returns:
      true if check administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckNotification

      boolean supportsCheckNotification()
      Tests if a check notification service is supported.
      Returns:
      true if check notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckEngine

      boolean supportsCheckEngine()
      Tests if a check engine lookup service is supported.
      Returns:
      true if a check engine lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckEngineAssignment

      boolean supportsCheckEngineAssignment()
      Tests if a check engine service is supported.
      Returns:
      true if check to engine assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckSmartEngine

      boolean supportsCheckSmartEngine()
      Tests if a check smart engine lookup service is supported.
      Returns:
      true if a check smart engine service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • getAgendaRecordTypes

      TypeList getAgendaRecordTypes()
      Gets the supported Agenda record types.
      Returns:
      a list containing the supported Agenda record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaRecordType

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

      TypeList getAgendaSearchRecordTypes()
      Gets the supported Agenda search record types.
      Returns:
      a list containing the supported Agenda search record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaSearchRecordType

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

      TypeList getAgendaConditionRecordTypes()
      Gets the supported AgendaCondition record types.
      Returns:
      a list containing the supported AgendaCondition record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsAgendaConditionRecordType

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

      TypeList getInstructionRecordTypes()
      Gets the supported Instruction record types.
      Returns:
      a list containing the supported Instruction record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionRecordType

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

      TypeList getInstructionSearchRecordTypes()
      Gets the supported Instruction search types.
      Returns:
      a list containing the supported Instruction search types
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionSearchRecordType

      boolean supportsInstructionSearchRecordType(Type instructionSearchRecordType)
      Tests if the given Instruction search type is supported.
      Parameters:
      instructionSearchRecordType - a Type indicating an Instruction search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - instructionSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.
    • getInstructionConditionRecordTypes

      TypeList getInstructionConditionRecordTypes()
      Gets the supported InstructionCondition record types.
      Returns:
      a list containing the supported InstructionCondition record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsInstructionConditionRecordType

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

      TypeList getCheckRecordTypes()
      Gets the supported Check record types.
      Returns:
      a list containing the supported Check record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckRecordType

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

      TypeList getCheckSearchRecordTypes()
      Gets the supported Check search record types.
      Returns:
      a list containing the supported Check search record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckSearchRecordType

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

      TypeList getCheckConditionRecordTypes()
      Gets the supported CheckCondition record types.
      Returns:
      a list containing the supported CheckCondition record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckConditionRecordType

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

      TypeList getCheckResultRecordTypes()
      Gets the supported CheckResult record types.
      Returns:
      a list containing the supported CheckResult record types
      Compliance:
      mandatory - This method must be implemented.
    • supportsCheckResultRecordType

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