org.osid.control.rules

Interface InputEnablerQueryInspector

All Superinterfaces:

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

public interface InputEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining input enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
InputEnablerQueryInspectorRecord	getInputEnablerQueryInspectorRecord(Type inputEnablerRecordType) Gets the input enabler query inspector record corresponding to the given InputEnabler record Type.
IdTerm[]	getRuledInputIdTerms() Gets the input Id query terms.
InputQueryInspector[]	getRuledInputTerms() Gets the input query terms.
IdTerm[]	getSystemIdTerms() Gets the system Id query terms.
SystemQueryInspector[]	getSystemTerms() Gets the system query terms.

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

getRuledInputIdTerms

IdTerm[] getRuledInputIdTerms()

Gets the input Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledInputTerms

InputQueryInspector[] getRuledInputTerms()

Gets the input query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSystemIdTerms

IdTerm[] getSystemIdTerms()

Gets the system Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSystemTerms

SystemQueryInspector[] getSystemTerms()

Gets the system query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInputEnablerQueryInspectorRecord

InputEnablerQueryInspectorRecord getInputEnablerQueryInspectorRecord(Type inputEnablerRecordType)
                                                                     throws OperationFailedException

Gets the input enabler query inspector record corresponding to the given InputEnabler record Type.

Parameters:

inputEnablerRecordType - an input enabler record type

Returns:

the input enabler query inspector record

Throws:

NullArgumentException - inputEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inputEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.