org.osid.installation

Interface SiteQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface SiteQuery
extends OsidObjectQuery

This is the query for searching installations. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearInstallationIdTerms() Clears the installation Id query terms.
void	clearInstallationTerms() Clears the installation query terms.
SiteQuery	getInstallationQuery() Gets the query for an installation.
SiteQueryRecord	getSiteQueryRecord(Type siteRecordType) Gets the site query record corresponding to the given Site record Type.
void	matchAnyInstallation(boolean match) Matches sites with any installation.
void	matchInstallationId(Id installationId, boolean match) Sets the installation Id for this query.
boolean	supportsInstallationQuery() Tests if an InstallationQuery is available for querying installations.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchInstallationId

void matchInstallationId(Id installationId,
                       boolean match)

Sets the installation Id for this query.

Parameters:

installationId - a site Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - installationId is null

Compliance:

mandatory - This method must be implemented.

clearInstallationIdTerms

void clearInstallationIdTerms()

Clears the installation Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsInstallationQuery

boolean supportsInstallationQuery()

Tests if an InstallationQuery is available for querying installations.

Returns:

true if an installation query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInstallationQuery

SiteQuery getInstallationQuery()

Gets the query for an installation. Multiple retrievals produce a nested OR term.

Returns:

the site query

Throws:

UnimplementedException - supportsInstallationQuery() is false

Compliance:

optional - This method must be implemented if supportsInstallationQuery() is true.

matchAnyInstallation

void matchAnyInstallation(boolean match)

Matches sites with any installation.

Parameters:

match - true to match sites with any package, false to match sites with no packages

Compliance:

mandatory - This method must be implemented.

clearInstallationTerms

void clearInstallationTerms()

Clears the installation query terms.

Compliance:

mandatory - This method must be implemented.

getSiteQueryRecord

SiteQueryRecord getSiteQueryRecord(Type siteRecordType)
                                   throws OperationFailedException

Gets the site query record corresponding to the given Site record Type. Multiple retrievals produce a nested OR term.

Parameters:

siteRecordType - a site query record type

Returns:

the site query record

Throws:

NullArgumentException - siteRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(siteRecordType) is false

Compliance:

mandatory - This method must be implemented.