Interface ParameterQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector

public interface ParameterQueryInspector
extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector

This is the query inspector for examning parameter queries.

Method Summary

Modifier and Type	Method	Description
CardinalRangeTerm[]	getInputPositionTerms()	Gets the input position query terms.
ParameterQueryInspectorRecord	getParameterQueryInspectorRecord(Type parameterRecordType)	Gets the parameter query inspector record corresponding to the given Parameter record Type .
IdTerm[]	getPressIdTerms()	Gets the press Id query terms.
PressQueryInspector[]	getPressTerms()	Gets the press query terms.
SyntaxTerm[]	getSyntaxTerms()	Gets the syntax query terms.
IdTerm[]	getTextIdTerms()	Gets the text Id query terms.
TextQueryInspector[]	getTextTerms()	Gets the text query terms.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQueryInspector

getRecordTypeTerms

Modifier and Type	Method	Description
TypeTerm[]	getRecordTypeTerms()	Gets the record type query terms.

Methods inherited from interface OsidIdentifiableQueryInspector

getIdTerms

Modifier and Type	Method	Description
IdTerm[]	getIdTerms()	Gets the Id query terms.

Methods inherited from interface OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Modifier and Type	Method	Description
IdTerm[]	getCommentIdTerms()	Gets the comment Id query terms.
CommentQueryInspector[]	getCommentTerms()	Gets the comment query terms.
IdTerm[]	getCreditIdTerms()	Gets the credit Id query terms.
CreditQueryInspector[]	getCreditTerms()	Gets the credit query terms.
StringTerm[]	getDescriptionTerms()	Gets the description query terms.
StringTerm[]	getDisplayNameTerms()	Gets the display name query terms.
TypeTerm[]	getGenusTypeTerms()	Gets the genus type query terms.
IdTerm[]	getJournalEntryIdTerms()	Gets the journal entry Id query terms.
JournalEntryQueryInspector[]	getJournalEntryTerms()	Gets the journal entry query terms.
TypeTerm[]	getParentGenusTypeTerms()	Gets the parent genus type query terms.
IdTerm[]	getRelationshipIdTerms()	Gets the relationship Id query terms.
IdTerm[]	getRelationshipPeerIdTerms()	Gets the relationship peer Id query terms.
RelationshipQueryInspector[]	getRelationshipTerms()	Gets the relationship query terms.
IdTerm[]	getStateIdTerms()	Gets the state Id query terms.
StateQueryInspector[]	getStateTerms()	Gets the state query terms.
StatisticQueryInspector[]	getStatisticTerms()	Gets the statistic query terms.
IdTerm[]	getSubjectIdTerms()	Gets the subject Id query terms.
RelevancyQueryInspector[]	getSubjectRelevancyTerms()	Gets the subject relevancy query terms.
SubjectQueryInspector[]	getSubjectTerms()	Gets the subject query terms.

Methods inherited from interface OsidQueryInspector

getAnyTerms, getKeywordTerms

Modifier and Type	Method	Description
BooleanTerm[]	getAnyTerms()	Gets the any query terms.
StringTerm[]	getKeywordTerms()	Gets the keyword query terms.

Method Details

getTextIdTerms

IdTerm[] getTextIdTerms()

Gets the text Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTextTerms

TextQueryInspector[] getTextTerms()

Gets the text query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSyntaxTerms

SyntaxTerm[] getSyntaxTerms()

Gets the syntax query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInputPositionTerms

CardinalRangeTerm[] getInputPositionTerms()

Gets the input position query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPressIdTerms

IdTerm[] getPressIdTerms()

Gets the press Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPressTerms

PressQueryInspector[] getPressTerms()

Gets the press query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getParameterQueryInspectorRecord

ParameterQueryInspectorRecord getParameterQueryInspectorRecord(Type parameterRecordType)
                                                        throws OperationFailedException

Gets the parameter query inspector 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.