org.osid.rules.check

Interface InstructionQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface InstructionQueryInspector
extends OsidRelationshipQueryInspector, OsidEnablerQueryInspector

This is the query inspector for examining instruction queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAgendaIdTerms() Gets the agenda Id query terms.
AgendaQueryInspector[]	getAgendaTerms() Gets the agenda query terms.
IdTerm[]	getCheckIdTerms() Gets the check query terms.
CheckQueryInspector[]	getCheckTerms() Gets the check query terms.
BooleanTerm[]	getContinueOnFailTerms() Gets the continue-on-fail query terms.
IdTerm[]	getEngineIdTerms() Gets the engine Id query terms.
EngineQueryInspector[]	getEngineTerms() Gets the engine query terms.
InstructionQueryInspectorRecord	getInstructionQueryInspectorRecord(Type instructionRecordType) Gets the instruction query inspector record corresponding to the given Instruction record Type.
StringTerm[]	getMessageTerms() Gets the message query terms.
BooleanTerm[]	getWarningTerms() Gets the warning query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getAgendaIdTerms

IdTerm[] getAgendaIdTerms()

Gets the agenda Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAgendaTerms

AgendaQueryInspector[] getAgendaTerms()

Gets the agenda query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCheckIdTerms

IdTerm[] getCheckIdTerms()

Gets the check query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCheckTerms

CheckQueryInspector[] getCheckTerms()

Gets the check query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMessageTerms

StringTerm[] getMessageTerms()

Gets the message query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getWarningTerms

BooleanTerm[] getWarningTerms()

Gets the warning query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getContinueOnFailTerms

BooleanTerm[] getContinueOnFailTerms()

Gets the continue-on-fail query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

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.

getInstructionQueryInspectorRecord

InstructionQueryInspectorRecord getInstructionQueryInspectorRecord(Type instructionRecordType)
                                                                   throws OperationFailedException,
                                                                          PermissionDeniedException

Gets the instruction query inspector record corresponding to the given Instruction record Type.

Parameters:

instructionRecordType - an instruction record type

Returns:

the instruction query inspector record

Throws:

NullArgumentException - instructionRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(instructionRecordType) is false

Compliance:

mandatory - This method must be implemented.