org.osid.configuration

Interface ParameterQueryInspector

All Superinterfaces:

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

public interface ParameterQueryInspector
extends OsidRuleQueryInspector

Inspects a parameter query.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getConfigurationIdTerms() Gets the configuration Id query terms.
ConfigurationQueryInspector[]	getConfigurationTerms() Gets the configuration query terms.
ParameterQueryInspectorRecord	getParameterQueryInspectorRecord(Type parameterRecordType) Gets the parameter query record corresponding to the given Parameter record Type.
TypeTerm[]	getValueCoordinateTypeTerms() Gets the coordinate record type query terms.
TypeTerm[]	getValueHeadingTypeTerms() Gets the heading record type query terms.
TypeTerm[]	getValueObjectTypeTerms() Gets the object value type query terms.
TypeTerm[]	getValueSpatialUnitRecordTypeTerms() Gets the spatial unit record type query terms.
BooleanTerm[]	getValuesShuffledTerms() Gets the shuffle query terms.
SyntaxTerm[]	getValueSyntaxTerms() Gets the value syntax query terms.
ValueQueryInspector[]	getValueTerms() Gets the value query terms.
TypeTerm[]	getValueVersionSchemeTerms() Gets the version type query terms.

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

Method Detail

getValueSyntaxTerms

SyntaxTerm[] getValueSyntaxTerms()

Gets the value syntax query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getValueCoordinateTypeTerms

TypeTerm[] getValueCoordinateTypeTerms()

Gets the coordinate record type query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getValueHeadingTypeTerms

TypeTerm[] getValueHeadingTypeTerms()

Gets the heading record type query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getValueObjectTypeTerms

TypeTerm[] getValueObjectTypeTerms()

Gets the object value type query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getValueSpatialUnitRecordTypeTerms

TypeTerm[] getValueSpatialUnitRecordTypeTerms()

Gets the spatial unit record type query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getValueVersionSchemeTerms

TypeTerm[] getValueVersionSchemeTerms()

Gets the version type query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getValueTerms

ValueQueryInspector[] getValueTerms()

Gets the value query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getValuesShuffledTerms

BooleanTerm[] getValuesShuffledTerms()

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

getParameterQueryInspectorRecord

ParameterQueryInspectorRecord getParameterQueryInspectorRecord(Type parameterRecordType)
                                                               throws OperationFailedException

Gets the parameter query record corresponding to the given Parameter record Type.

Parameters:

parameterRecordType - a parameter record type

Returns:

the parameter query inspector record

Throws:

NullArgumentException - parameterRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterRecordType) is false

Compliance:

mandatory - This method must be implemented.