Interface SiteQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface SiteQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining installations queries.

Like all OsidQueryInspectors, SiteQueryInspector is stateful and must not be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
IdTerm[]	getInstallationIdTerms()	Gets the installation Id query terms.
InstallationQueryInspector[]	getInstallationTerms()	Gets the installation query terms.
SiteQueryInspectorRecord	getSiteQueryInspectorRecord(Type siteRecordType)	Gets the query inspector record corresponding to the given Site record Type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface OsidObjectQueryInspector

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

Methods inherited from interface OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Details

getInstallationIdTerms

IdTerm[] getInstallationIdTerms()

Gets the installation Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInstallationTerms

InstallationQueryInspector[] getInstallationTerms()

Gets the installation query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSiteQueryInspectorRecord

SiteQueryInspectorRecord getSiteQueryInspectorRecord(Type siteRecordType)
                                              throws OperationFailedException

Gets the query inspector record corresponding to the given Site record Type.

Parameters:

siteRecordType - a site query record type

Returns:

the site query inspector record

Throws:

NullArgumentException - siteRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(siteRecordType) is false

Compliance:

mandatory - This method must be implemented.