OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.RulesCheckProfile
Implementsosid.OsidProfile
Description

The rules check profile describes the interoperability among rules check services.

MethodsupportsVisibleFederation
Description

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.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEvaluation
Description

Tests if an agenda evaluation service is supported for the current agent.

Returnboolean true if an evaluation service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProcessing
Description

Tests if an agenda processing service is supported .

Returnboolean true if a processing service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaLookup
Description

Tests if looking up agendas is supported.

Returnboolean true if agenda lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaQuery
Description

Tests if querying agendas is supported.

Returnboolean true if agenda query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaSearch
Description

Tests if searching agendas is supported.

Returnboolean true if agenda search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaAdmin
Description

Tests if agenda administrative service is supported.

Returnboolean true if agenda administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaNotification
Description

Tests if an agenda notification service is supported.

Returnboolean true if agenda notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaEngine
Description

Tests if an agenda engine lookup service is supported.

Returnboolean true if an agenda engine lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaEngineAssignment
Description

Tests if an agenda engine service is supported.

Returnboolean true if agenda to engine assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaSmartEngine
Description

Tests if an agenda smart engine lookup service is supported.

Returnboolean true if an agenda smart engine service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionLookup
Description

Tests if looking up instructions is supported.

Returnboolean true if instruction lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionQuery
Description

Tests if querying instructions is supported.

Returnboolean true if instruction query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionSearch
Description

Tests if searching instructions is supported.

Returnboolean true if instruction search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionAdmin
Description

Tests if instruction administrative service is supported.

Returnboolean true if instruction administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionNotification
Description

Tests if an instruction notification service is supported.

Returnboolean true if instruction notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionEngine
Description

Tests if an instruction engine lookup service is supported.

Returnboolean true if an instruction engine lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionEngineAssignment
Description

Tests if an instruction engine assignment service is supported.

Returnboolean true if an instruction to engine assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionSmartEngine
Description

Tests if an instruction smart engine service is supported.

Returnboolean true if an instruction smart engine service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckLookup
Description

Tests if looking up checks is supported.

Returnboolean true if check lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckQuery
Description

Tests if querying checks is supported.

Returnboolean true if check query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckSearch
Description

Tests if searching checks is supported.

Returnboolean true if check search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckAdmin
Description

Tests if check administrative service is supported.

Returnboolean true if check administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckNotification
Description

Tests if a check notification service is supported.

Returnboolean true if check notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckEngine
Description

Tests if a check engine lookup service is supported.

Returnboolean true if a check engine lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckEngineAssignment
Description

Tests if a check engine service is supported.

Returnboolean true if check to engine assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckSmartEngine
Description

Tests if a check smart engine lookup service is supported.

Returnboolean true if a check smart engine service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgendaRecordTypes
Description

Gets the supported Agenda record types.

Returnosid.type.TypeLista list containing the supported Agenda record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaRecordType
Description

Tests if the given Agenda record type is supported.

Parametersosid.type.TypeagendaRecordTypea Type indicating an Agenda record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT agendaRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAgendaSearchRecordTypes
Description

Gets the supported Agenda search record types.

Returnosid.type.TypeLista list containing the supported Agenda search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAgendaSearchRecordType
Description

Tests if the given Agenda search record type is supported.

Parametersosid.type.TypeagendaSearchRecordTypea Type indicating an Agenda search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT agendaSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetInstructionRecordTypes
Description

Gets the supported Instruction record types.

Returnosid.type.TypeLista list containing the supported Instruction record types
CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionRecordType
Description

Tests if the given Instruction record type is supported.

Parametersosid.type.TypeinstructionRecordTypea Type indicating an Instruction record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT instructionRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetInstructionSearchRecordTypes
Description

Gets the supported Instruction search types.

Returnosid.type.TypeLista list containing the supported Instruction search types
CompliancemandatoryThis method must be implemented.
MethodsupportsInstructionSearchRecordType
Description

Tests if the given Instruction search type is supported.

Parametersosid.type.TypeinstructionSearchRecordTypea Type indicating an Instruction search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT instructionSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCheckRecordTypes
Description

Gets the supported Check record types.

Returnosid.type.TypeLista list containing the supported Check record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckRecordType
Description

Tests if the given Check record type is supported.

Parametersosid.type.TypecheckRecordTypea Type indicating a Check record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT checkRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCheckSearchRecordTypes
Description

Gets the supported Check search record types.

Returnosid.type.TypeLista list containing the supported Check search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckSearchRecordType
Description

Tests if the given Check search record type is supported.

Parametersosid.type.TypecheckSearchRecordTypea Type indicating a Check search record type
Returnboolean true if the given search record type is supported, false otherwise
ErrorsNULL_ARGUMENT checkSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCheckResultRecordTypes
Description

Gets the supported CheckResult record types.

Returnosid.type.TypeLista list containing the supported CheckResult record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCheckResultRecordType
Description

Tests if the given CheckResult record type is supported.

Parametersosid.type.TypecheckResultRecordTypea Type indicating a CheckResult record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT checkResultRecordType is null
CompliancemandatoryThis method must be implemented.