OSID - osid.rules.RulesProfile Service Interface Definition

Interface	osid.rules.RulesProfile
Implements	`osid.OsidProfile`
Description	The rules profile describes the interoperability among rule 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	supportsRules
Description	Tests if rule evaluation is supported.
Return	`boolean`		`true` if rule evaluation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleLookup
Description	Tests for the availability of a rule lookup service.
Return	`boolean`		`true` if rule lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleQuery
Description	Tests if querying rules is available.
Return	`boolean`		`true` if rule query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleSearch
Description	Tests if searching for rules is available.
Return	`boolean`		`true` if rule search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleAdmin
Description	Tests if managing rules is available.
Return	`boolean`		`true` if rule admin is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleNotification
Description	Tests if rule notification is available.
Return	`boolean`		`true` if rule notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleEngine
Description	Tests if rule cataloging is available.
Return	`boolean`		`true` if rule cataloging is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleEngineAssignment
Description	Tests if a rule cataloging assignment service is supported. A rule cataloging service maps rules to engines.
Return	`boolean`		`true` if rule cataloging is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleSmartEngine
Description	Tests if rule smart engines is available.
Return	`boolean`		`true` if rule smart engines is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineLookup
Description	Tests for the availability of an engine lookup service.
Return	`boolean`		`true` if engine lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineQuery
Description	Tests for the availability of an engine query service.
Return	`boolean`		`true` if engine query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineSearch
Description	Tests if searching for engines is available.
Return	`boolean`		`true` if engine search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineAdmin
Description	Tests for the availability of a engine administrative service for creating and deleting engines.
Return	`boolean`		`true` if engine administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineNotification
Description	Tests for the availability of an engine notification service.
Return	`boolean`		`true` if engine notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsEngineHierarchy
Description	Tests for the availability of an engine hierarchy traversal service.
Return	`boolean`		`true` if engine hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineHierarchyDesign
Description	Tests for the availability of an engine hierarchy design service.
Return	`boolean`		`true` if engine hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsRulesCheck
Description	Tests for the availability of a rules check service.
Return	`boolean`		`true` if a rules check service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	getRuleRecordTypes
Description	Gets the supported `Rule` record types.
Return	`osid.type.TypeList`		a list containing the supported rule record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleRecordType
Description	Tests if the given `Rule` record type is supported.
Parameters	`osid.type.Type`	`ruleRecordType`	a `Type` indicating a `Rule` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`ruleRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRuleSearchRecordTypes
Description	Gets the supported rule search record types.
Return	`osid.type.TypeList`		a list containing the supported rule search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleSearchRecordType
Description	Tests if the given rule search record type is supported.
Parameters	`osid.type.Type`	`ruleSearchRecordType`	a `Type` indicating a rule record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`ruleSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEngineRecordTypes
Description	Gets the supported `Engine` record types.
Return	`osid.type.TypeList`		a list containing the supported engine record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineRecordType
Description	Tests if the given `Engine` record type is supported.
Parameters	`osid.type.Type`	`engineRecordType`	a `Type` indicating an `Engine` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`engineRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEngineSearchRecordTypes
Description	Gets the supported engine search record types.
Return	`osid.type.TypeList`		a list containing the supported engine search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEngineSearchRecordType
Description	Tests if the given engine search record type is supported.
Parameters	`osid.type.Type`	`engineSearchRecordType`	a `Type` indicating an engine record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`engineSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.