org.osid.rules.check

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 Summary

Methods

Modifier and Type	Method and Description
TypeList	getAgendaRecordTypes() Gets the supported Agenda record types.
TypeList	getAgendaSearchRecordTypes() Gets the supported Agenda search record types.
TypeList	getCheckRecordTypes() Gets the supported Check record types.
TypeList	getCheckResultRecordTypes() Gets the supported CheckResult record types.
TypeList	getCheckSearchRecordTypes() Gets the supported Check search record types.
TypeList	getInstructionRecordTypes() Gets the supported Instruction record types.
TypeList	getInstructionSearchRecordTypes() Gets the supported Instruction search types.
boolean	supportsAgendaAdmin() Tests if agenda administrative service is supported.
boolean	supportsAgendaEngine() Tests if an agenda engine lookup service is supported.
boolean	supportsAgendaEngineAssignment() Tests if an agenda engine service is supported.
boolean	supportsAgendaLookup() Tests if looking up agendas is supported.
boolean	supportsAgendaNotification() Tests if an agenda notification service is supported.
boolean	supportsAgendaQuery() Tests if querying agendas is supported.
boolean	supportsAgendaRecordType(Type agendaRecordType) Tests if the given Agenda record type is supported.
boolean	supportsAgendaSearch() Tests if searching agendas is supported.
boolean	supportsAgendaSearchRecordType(Type agendaSearchRecordType) Tests if the given Agenda search record type is supported.
boolean	supportsAgendaSmartEngine() Tests if an agenda smart engine lookup service is supported.
boolean	supportsCheckAdmin() Tests if check administrative service is supported.
boolean	supportsCheckEngine() Tests if a check engine lookup service is supported.
boolean	supportsCheckEngineAssignment() Tests if a check engine service is supported.
boolean	supportsCheckLookup() Tests if looking up checks is supported.
boolean	supportsCheckNotification() Tests if a check notification service is supported.
boolean	supportsCheckQuery() Tests if querying checks is supported.
boolean	supportsCheckRecordType(Type checkRecordType) Tests if the given Check record type is supported.
boolean	supportsCheckResultRecordType(Type checkResultRecordType) Tests if the given CheckResult record type is supported.
boolean	supportsCheckSearch() Tests if searching checks is supported.
boolean	supportsCheckSearchRecordType(Type checkSearchRecordType) Tests if the given Check search record type is supported.
boolean	supportsCheckSmartEngine() Tests if a check smart engine lookup service is supported.
boolean	supportsEvaluation() Tests if an agenda evaluation service is supported for the current agent.
boolean	supportsInstructionAdmin() Tests if instruction administrative service is supported.
boolean	supportsInstructionEngine() Tests if an instruction engine lookup service is supported.
boolean	supportsInstructionEngineAssignment() Tests if an instruction engine assignment service is supported.
boolean	supportsInstructionLookup() Tests if looking up instructions is supported.
boolean	supportsInstructionNotification() Tests if an instruction notification service is supported.
boolean	supportsInstructionQuery() Tests if querying instructions is supported.
boolean	supportsInstructionRecordType(Type instructionRecordType) Tests if the given Instruction record type is supported.
boolean	supportsInstructionSearch() Tests if searching instructions is supported.
boolean	supportsInstructionSearchRecordType(Type instructionSearchRecordType) Tests if the given Instruction search type is supported.
boolean	supportsInstructionSmartEngine() Tests if an instruction smart engine service is supported.
boolean	supportsProcessing() Tests if an agenda processing service is supported .
boolean	supportsVisibleFederation() Tests if any engine federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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.

supportsEvaluation

boolean supportsEvaluation()

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

Returns:

true if an evaluation service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProcessing

boolean supportsProcessing()

Tests if an agenda processing service is supported .

Returns:

true if a processing 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.

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.

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.

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.

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.

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.