org.osid.control.rules

Interface TriggerEnablerQueryInspector

All Superinterfaces:

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

public interface TriggerEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining trigger enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getRuledTriggerIdTerms() Gets the trigger Id query terms.
TriggerQueryInspector[]	getRuledTriggerTerms() Gets the trigger query terms.
IdTerm[]	getSystemIdTerms() Gets the system Id query terms.
SystemQueryInspector[]	getSystemTerms() Gets the system query terms.
TriggerEnablerQueryInspectorRecord	getTriggerEnablerQueryInspectorRecord(Type triggerEnablerRecordType) Gets the trigger enabler query inspector record corresponding to the given TriggerEnabler record Type.

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

getRuledTriggerIdTerms

IdTerm[] getRuledTriggerIdTerms()

Gets the trigger Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledTriggerTerms

TriggerQueryInspector[] getRuledTriggerTerms()

Gets the trigger 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.

getTriggerEnablerQueryInspectorRecord

TriggerEnablerQueryInspectorRecord getTriggerEnablerQueryInspectorRecord(Type triggerEnablerRecordType)
                                                                         throws OperationFailedException

Gets the trigger enabler query inspector record corresponding to the given TriggerEnabler record Type.

Parameters:

triggerEnablerRecordType - a trigger enabler record type

Returns:

the trigger enabler query inspector record

Throws:

NullArgumentException - triggerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(triggerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.