org.osid.sequencing

Interface ChainQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface ChainQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining chain queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAntimatroidIdTerms() Gets the antimatroid Id query terms.
AntimatroidQueryInspector[]	getAntimatroidTerms() Gets the antimatroid query terms.
ChainQueryInspectorRecord	getChainQueryInspectorRecord(Type chainRecordType) Gets the chain query inspector record corresponding to the given Chain record Type.
IdTerm[]	getElementTerms() Gets the element Id query terms.
BooleanTerm[]	getFifoTerms() Gets the fifo query terms.

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

Method Detail

getFifoTerms

BooleanTerm[] getFifoTerms()

Gets the fifo query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getElementTerms

IdTerm[] getElementTerms()

Gets the element Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAntimatroidIdTerms

IdTerm[] getAntimatroidIdTerms()

Gets the antimatroid Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAntimatroidTerms

AntimatroidQueryInspector[] getAntimatroidTerms()

Gets the antimatroid query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getChainQueryInspectorRecord

ChainQueryInspectorRecord getChainQueryInspectorRecord(Type chainRecordType)
                                                       throws OperationFailedException

Gets the chain query inspector record corresponding to the given Chain record Type.

Parameters:

chainRecordType - a chain record type

Returns:

the chain query inspector record

Throws:

NullArgumentException - chainRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(chainRecordType) is false

Compliance:

mandatory - This method must be implemented.