Interface RulesCheckProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
RulesCheckManager, RulesCheckProxyManager
The rules check profile describes the interoperability among rules check services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedAgendaConditionrecord types.Gets the supportedAgendarecord types.Gets the supportedAgendasearch record types.Gets the supportedCheckConditionrecord types.Gets the supportedCheckrecord types.Gets the supportedCheckResultrecord types.Gets the supportedChecksearch record types.Gets the supportedInstructionConditionrecord types.Gets the supportedInstructionrecord types.Gets the supportedInstructionsearch types.booleanTests if an agenda evaluation service is supported.booleanTests if agenda administrative service is supported.booleansupportsAgendaConditionRecordType(Type agendaConditionRecordType) Tests if the givenAgendaConditionrecord type is supported.booleanTests if an agenda engine lookup service is supported.booleanTests if an agenda engine service is supported.booleanTests if an agenda evaluation service with detailed results is supported.booleanTests if looking up agendas is supported.booleanTests if an agenda notification service is supported.booleanTests if querying agendas is supported.booleansupportsAgendaRecordType(Type agendaRecordType) Tests if the givenAgendarecord type is supported.booleanTests if searching agendas is supported.booleansupportsAgendaSearchRecordType(Type agendaSearchRecordType) Tests if the givenAgendasearch record type is supported.booleanTests if an agenda smart engine lookup service is supported.booleanTests if check administrative service is supported.booleansupportsCheckConditionRecordType(Type checkConditionRecordType) Tests if the givenCheckConditionrecord type is supported.booleanTests if a check engine lookup service is supported.booleanTests if a check engine service is supported.booleanTests if evaluating checks is supported.booleanTests if looking up checks is supported.booleanTests if a check notification service is supported.booleanTests if querying checks is supported.booleansupportsCheckRecordType(Type checkRecordType) Tests if the givenCheckrecord type is supported.booleansupportsCheckResultRecordType(Type checkResultRecordType) Tests if the givenCheckResultrecord type is supported.booleanTests if searching checks is supported.booleansupportsCheckSearchRecordType(Type checkSearchRecordType) Tests if the givenChecksearch record type is supported.booleanTests if a check smart engine lookup service is supported.booleanTests if instruction administrative service is supported.booleanTests if evaluating instruction applicability is supported.booleansupportsInstructionConditionRecordType(Type instructionConditionRecordType) Tests if the givenInstructionConditionrecord type is supported.booleanTests if an instruction engine lookup service is supported.booleanTests if an instruction engine assignment service is supported.booleanTests if looking up instructions is supported.booleanTests if an instruction notification service is supported.booleanTests if querying instructions is supported.booleansupportsInstructionRecordType(Type instructionRecordType) Tests if the givenInstructionrecord type is supported.booleanTests if searching instructions is supported.booleansupportsInstructionSearchRecordType(Type instructionSearchRecordType) Tests if the givenInstructionsearch type is supported.booleanTests if an instruction smart engine service is supported.booleanTests if any engine federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
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:
trueif visible federation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAgenda
boolean supportsAgenda()Tests if an agenda evaluation service is supported.- Returns:
trueif an agenda evaluation service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAgendaEvaluation
boolean supportsAgendaEvaluation()Tests if an agenda evaluation service with detailed results is supported.- Returns:
trueif an agenda evaluation service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAgendaLookup
boolean supportsAgendaLookup()Tests if looking up agendas is supported.- Returns:
trueif agenda lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAgendaQuery
boolean supportsAgendaQuery()Tests if querying agendas is supported.- Returns:
trueif agenda query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAgendaSearch
boolean supportsAgendaSearch()Tests if searching agendas is supported.- Returns:
trueif agenda search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAgendaAdmin
boolean supportsAgendaAdmin()Tests if agenda administrative service is supported.- Returns:
trueif agenda administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAgendaNotification
boolean supportsAgendaNotification()Tests if an agenda notification service is supported.- Returns:
trueif agenda notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAgendaEngine
boolean supportsAgendaEngine()Tests if an agenda engine lookup service is supported.- Returns:
trueif an agenda engine lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAgendaEngineAssignment
boolean supportsAgendaEngineAssignment()Tests if an agenda engine service is supported.- Returns:
trueif agenda to engine assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsAgendaSmartEngine
boolean supportsAgendaSmartEngine()Tests if an agenda smart engine lookup service is supported.- Returns:
trueif an agenda smart engine service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstructionApplicability
boolean supportsInstructionApplicability()Tests if evaluating instruction applicability is supported.- Returns:
trueif instruction evaluation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstructionLookup
boolean supportsInstructionLookup()Tests if looking up instructions is supported.- Returns:
trueif instruction lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstructionQuery
boolean supportsInstructionQuery()Tests if querying instructions is supported.- Returns:
trueif instruction query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstructionSearch
boolean supportsInstructionSearch()Tests if searching instructions is supported.- Returns:
trueif instruction search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstructionAdmin
boolean supportsInstructionAdmin()Tests if instruction administrative service is supported.- Returns:
trueif instruction administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstructionNotification
boolean supportsInstructionNotification()Tests if an instruction notification service is supported.- Returns:
trueif instruction notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstructionEngine
boolean supportsInstructionEngine()Tests if an instruction engine lookup service is supported.- Returns:
trueif an instruction engine lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstructionEngineAssignment
boolean supportsInstructionEngineAssignment()Tests if an instruction engine assignment service is supported.- Returns:
trueif an instruction to engine assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInstructionSmartEngine
boolean supportsInstructionSmartEngine()Tests if an instruction smart engine service is supported.- Returns:
trueif an instruction smart engine service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCheckEvaluation
boolean supportsCheckEvaluation()Tests if evaluating checks is supported.- Returns:
trueif check evaluation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCheckLookup
boolean supportsCheckLookup()Tests if looking up checks is supported.- Returns:
trueif check lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCheckQuery
boolean supportsCheckQuery()Tests if querying checks is supported.- Returns:
trueif check query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCheckSearch
boolean supportsCheckSearch()Tests if searching checks is supported.- Returns:
trueif check search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCheckAdmin
boolean supportsCheckAdmin()Tests if check administrative service is supported.- Returns:
trueif check administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCheckNotification
boolean supportsCheckNotification()Tests if a check notification service is supported.- Returns:
trueif check notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCheckEngine
boolean supportsCheckEngine()Tests if a check engine lookup service is supported.- Returns:
trueif a check engine lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCheckEngineAssignment
boolean supportsCheckEngineAssignment()Tests if a check engine service is supported.- Returns:
trueif check to engine assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCheckSmartEngine
boolean supportsCheckSmartEngine()Tests if a check smart engine lookup service is supported.- Returns:
trueif a check smart engine service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getAgendaRecordTypes
TypeList getAgendaRecordTypes()Gets the supportedAgendarecord types.- Returns:
- a list containing the supported
Agendarecord types - Compliance:
mandatory- This method must be implemented.
-
supportsAgendaRecordType
Tests if the givenAgendarecord type is supported.- Parameters:
agendaRecordType- aTypeindicating anAgendarecord type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-agendaRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getAgendaSearchRecordTypes
TypeList getAgendaSearchRecordTypes()Gets the supportedAgendasearch record types.- Returns:
- a list containing the supported
Agendasearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsAgendaSearchRecordType
Tests if the givenAgendasearch record type is supported.- Parameters:
agendaSearchRecordType- aTypeindicating anAgendasearch record type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-agendaSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getAgendaConditionRecordTypes
TypeList getAgendaConditionRecordTypes()Gets the supportedAgendaConditionrecord types.- Returns:
- a list containing the supported
AgendaConditionrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsAgendaConditionRecordType
Tests if the givenAgendaConditionrecord type is supported.- Parameters:
agendaConditionRecordType- aTypeindicating anAgendaConditionrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-agendaConditionRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getInstructionRecordTypes
TypeList getInstructionRecordTypes()Gets the supportedInstructionrecord types.- Returns:
- a list containing the supported
Instructionrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsInstructionRecordType
Tests if the givenInstructionrecord type is supported.- Parameters:
instructionRecordType- aTypeindicating anInstructionrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-instructionRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getInstructionSearchRecordTypes
TypeList getInstructionSearchRecordTypes()Gets the supportedInstructionsearch types.- Returns:
- a list containing the supported
Instructionsearch types - Compliance:
mandatory- This method must be implemented.
-
supportsInstructionSearchRecordType
Tests if the givenInstructionsearch type is supported.- Parameters:
instructionSearchRecordType- aTypeindicating anInstructionsearch type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-instructionSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getInstructionConditionRecordTypes
TypeList getInstructionConditionRecordTypes()Gets the supportedInstructionConditionrecord types.- Returns:
- a list containing the supported
InstructionConditionrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsInstructionConditionRecordType
Tests if the givenInstructionConditionrecord type is supported.- Parameters:
instructionConditionRecordType- aTypeindicating anInstructionConditionrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-instructionConditionRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getCheckRecordTypes
TypeList getCheckRecordTypes()Gets the supportedCheckrecord types.- Returns:
- a list containing the supported
Checkrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsCheckRecordType
Tests if the givenCheckrecord type is supported.- Parameters:
checkRecordType- aTypeindicating aCheckrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-checkRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getCheckSearchRecordTypes
TypeList getCheckSearchRecordTypes()Gets the supportedChecksearch record types.- Returns:
- a list containing the supported
Checksearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsCheckSearchRecordType
Tests if the givenChecksearch record type is supported.- Parameters:
checkSearchRecordType- aTypeindicating aChecksearch record type- Returns:
trueif the given search record type is supported,falseotherwise- Throws:
NullArgumentException-checkSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getCheckConditionRecordTypes
TypeList getCheckConditionRecordTypes()Gets the supportedCheckConditionrecord types.- Returns:
- a list containing the supported
CheckConditionrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsCheckConditionRecordType
Tests if the givenCheckConditionrecord type is supported.- Parameters:
checkConditionRecordType- aTypeindicating aCheckConditionrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-checkConditionRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getCheckResultRecordTypes
TypeList getCheckResultRecordTypes()Gets the supportedCheckResultrecord types.- Returns:
- a list containing the supported
CheckResultrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsCheckResultRecordType
Tests if the givenCheckResultrecord type is supported.- Parameters:
checkResultRecordType- aTypeindicating aCheckResultrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-checkResultRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-