org.osid.control.rules

Interface ActionEnablerQueryInspector

All Superinterfaces:

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

public interface ActionEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining action enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
ActionEnablerQueryInspectorRecord	getActionEnablerQueryInspectorRecord(Type actionEnablerRecordType) Gets the action enabler query inspector record corresponding to the given ActionEnabler record Type.
IdTerm[]	getRuledActionIdTerms() Gets the action Id query terms.
ActionQueryInspector[]	getRuledActionTerms() Gets the action 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

getRuledActionIdTerms

IdTerm[] getRuledActionIdTerms()

Gets the action Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledActionTerms

ActionQueryInspector[] getRuledActionTerms()

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

getActionEnablerQueryInspectorRecord

ActionEnablerQueryInspectorRecord getActionEnablerQueryInspectorRecord(Type actionEnablerRecordType)
                                                                       throws OperationFailedException

Gets the action enabler query inspector record corresponding to the given ActionEnabler record Type.

Parameters:

actionEnablerRecordType - an action enabler record type

Returns:

the action enabler query inspector record

Throws:

NullArgumentException - actionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.