org.osid.rules

Interface RuleQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface RuleQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining rule queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getEngineIdTerms() Gets the engine Id query terms.
EngineQueryInspector[]	getEngineTerms() Gets the engine query terms.
RuleQueryInspectorRecord	getRuleQueryInspectorRecord(Type ruleRecordType) Gets the rule query inspector record corresponding to the given Rule record Type.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

getEngineIdTerms

IdTerm[] getEngineIdTerms()

Gets the engine Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEngineTerms

EngineQueryInspector[] getEngineTerms()

Gets the engine query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuleQueryInspectorRecord

RuleQueryInspectorRecord getRuleQueryInspectorRecord(Type ruleRecordType)
                                                     throws OperationFailedException

Gets the rule query inspector record corresponding to the given Rule record Type.

Parameters:

ruleRecordType - a rule record type

Returns:

the rule query inspector record

Throws:

NullArgumentException - ruleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ruleRecordType) is false

Compliance:

mandatory - This method must be implemented.