org.osid.configuration.rules

Interface ValueEnablerQueryInspector

All Superinterfaces:

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

public interface ValueEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining value enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getConfigurationIdTerms() Gets the configuration Id query terms.
ConfigurationQueryInspector[]	getConfigurationTerms() Gets the configuration query terms.
IdTerm[]	getRuledValueIdTerms() Gets the value Id query terms.
ValueQueryInspector[]	getRuledValueTerms() Gets the value query terms.
ValueEnablerQueryInspectorRecord	getValueEnablerQueryInspectorRecord(Type valueEnablerRecordType) Gets the value enabler query inspector record corresponding to the given ValueEnabler 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

getRuledValueIdTerms

IdTerm[] getRuledValueIdTerms()

Gets the value Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledValueTerms

ValueQueryInspector[] getRuledValueTerms()

Gets the value query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getConfigurationIdTerms

IdTerm[] getConfigurationIdTerms()

Gets the configuration Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getConfigurationTerms

ConfigurationQueryInspector[] getConfigurationTerms()

Gets the configuration query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getValueEnablerQueryInspectorRecord

ValueEnablerQueryInspectorRecord getValueEnablerQueryInspectorRecord(Type valueEnablerRecordType)
                                                                     throws OperationFailedException

Gets the value enabler query inspector record corresponding to the given ValueEnabler record Type.

Parameters:

valueEnablerRecordType - a value enabler record type

Returns:

the value enabler query inspector record

Throws:

NullArgumentException - valueEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(valueEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.