OSID - osid.rules.check.RulesCheckProfile Service Interface Definition

Interface	osid.rules.check.RulesCheckProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.rules.check.RulesCheckManager`
Implemented By	`osid.rules.check.RulesCheckProxyManager`
Description	The rules check profile describes the interoperability among rules check services.
Method	supportsVisibleFederation
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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgenda
Description	Tests if an agenda evaluation service is supported.
Return	`boolean`		`true` if an agenda evaluation service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaEvaluation
Description	Tests if an agenda evaluation service with detailed results is supported.
Return	`boolean`		`true` if an agenda evaluation service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaLookup
Description	Tests if looking up agendas is supported.
Return	`boolean`		`true` if agenda lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaQuery
Description	Tests if querying agendas is supported.
Return	`boolean`		`true` if agenda query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaSearch
Description	Tests if searching agendas is supported.
Return	`boolean`		`true` if agenda search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaAdmin
Description	Tests if agenda administrative service is supported.
Return	`boolean`		`true` if agenda administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaNotification
Description	Tests if an agenda notification service is supported.
Return	`boolean`		`true` if agenda notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaEngine
Description	Tests if an agenda engine lookup service is supported.
Return	`boolean`		`true` if an agenda engine lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaEngineAssignment
Description	Tests if an agenda engine service is supported.
Return	`boolean`		`true` if agenda to engine assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaSmartEngine
Description	Tests if an agenda smart engine lookup service is supported.
Return	`boolean`		`true` if an agenda smart engine service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionApplicability
Description	Tests if evaluating instruction applicability is supported.
Return	`boolean`		`true` if instruction evaluation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionLookup
Description	Tests if looking up instructions is supported.
Return	`boolean`		`true` if instruction lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionQuery
Description	Tests if querying instructions is supported.
Return	`boolean`		`true` if instruction query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionSearch
Description	Tests if searching instructions is supported.
Return	`boolean`		`true` if instruction search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionAdmin
Description	Tests if instruction administrative service is supported.
Return	`boolean`		`true` if instruction administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionNotification
Description	Tests if an instruction notification service is supported.
Return	`boolean`		`true` if instruction notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionEngine
Description	Tests if an instruction engine lookup service is supported.
Return	`boolean`		`true` if an instruction engine lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionEngineAssignment
Description	Tests if an instruction engine assignment service is supported.
Return	`boolean`		`true` if an instruction to engine assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionSmartEngine
Description	Tests if an instruction smart engine service is supported.
Return	`boolean`		`true` if an instruction smart engine service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckEvaluation
Description	Tests if evaluating checks is supported.
Return	`boolean`		`true` if check evaluation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckLookup
Description	Tests if looking up checks is supported.
Return	`boolean`		`true` if check lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckQuery
Description	Tests if querying checks is supported.
Return	`boolean`		`true` if check query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckSearch
Description	Tests if searching checks is supported.
Return	`boolean`		`true` if check search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckAdmin
Description	Tests if check administrative service is supported.
Return	`boolean`		`true` if check administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckNotification
Description	Tests if a check notification service is supported.
Return	`boolean`		`true` if check notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckEngine
Description	Tests if a check engine lookup service is supported.
Return	`boolean`		`true` if a check engine lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckEngineAssignment
Description	Tests if a check engine service is supported.
Return	`boolean`		`true` if check to engine assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckSmartEngine
Description	Tests if a check smart engine lookup service is supported.
Return	`boolean`		`true` if a check smart engine service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaRecordTypes
Description	Gets the supported `Agenda` record types.
Return	`osid.type.TypeList`		a list containing the supported `Agenda` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaRecordType
Description	Tests if the given `Agenda` record type is supported.
Parameters	`osid.type.Type`	`agendaRecordType`	a `Type` indicating an `Agenda` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`agendaRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaSearchRecordTypes
Description	Gets the supported `Agenda` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Agenda` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaSearchRecordType
Description	Tests if the given `Agenda` search record type is supported.
Parameters	`osid.type.Type`	`agendaSearchRecordType`	a `Type` indicating an `Agenda` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`agendaSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaConditionRecordTypes
Description	Gets the supported `AgendaCondition` record types.
Return	`osid.type.TypeList`		a list containing the supported `AgendaCondition` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgendaConditionRecordType
Description	Tests if the given `AgendaCondition` record type is supported.
Parameters	`osid.type.Type`	`agendaConditionRecordType`	a `Type` indicating an `AgendaCondition` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`agendaConditionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionRecordTypes
Description	Gets the supported `Instruction` record types.
Return	`osid.type.TypeList`		a list containing the supported `Instruction` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionRecordType
Description	Tests if the given `Instruction` record type is supported.
Parameters	`osid.type.Type`	`instructionRecordType`	a `Type` indicating an `Instruction` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`instructionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionSearchRecordTypes
Description	Gets the supported `Instruction` search types.
Return	`osid.type.TypeList`		a list containing the supported `Instruction` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionSearchRecordType
Description	Tests if the given `Instruction` search type is supported.
Parameters	`osid.type.Type`	`instructionSearchRecordType`	a `Type` indicating an `Instruction` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`instructionSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInstructionConditionRecordTypes
Description	Gets the supported `InstructionCondition` record types.
Return	`osid.type.TypeList`		a list containing the supported `InstructionCondition` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsInstructionConditionRecordType
Description	Tests if the given `InstructionCondition` record type is supported.
Parameters	`osid.type.Type`	`instructionConditionRecordType`	a `Type` indicating an `InstructionCondition` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`instructionConditionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCheckRecordTypes
Description	Gets the supported `Check` record types.
Return	`osid.type.TypeList`		a list containing the supported `Check` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckRecordType
Description	Tests if the given `Check` record type is supported.
Parameters	`osid.type.Type`	`checkRecordType`	a `Type` indicating a `Check` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`checkRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCheckSearchRecordTypes
Description	Gets the supported `Check` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Check` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckSearchRecordType
Description	Tests if the given `Check` search record type is supported.
Parameters	`osid.type.Type`	`checkSearchRecordType`	a `Type` indicating a `Check` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`checkSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCheckConditionRecordTypes
Description	Gets the supported `CheckCondition` record types.
Return	`osid.type.TypeList`		a list containing the supported `CheckCondition` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckConditionRecordType
Description	Tests if the given `CheckCondition` record type is supported.
Parameters	`osid.type.Type`	`checkConditionRecordType`	a `Type` indicating a `CheckCondition` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`checkConditionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCheckResultRecordTypes
Description	Gets the supported `CheckResult` record types.
Return	`osid.type.TypeList`		a list containing the supported `CheckResult` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCheckResultRecordType
Description	Tests if the given `CheckResult` record type is supported.
Parameters	`osid.type.Type`	`checkResultRecordType`	a `Type` indicating a `CheckResult` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`checkResultRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.