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.
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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchInstallationId(Id installationId, boolean match)
Id
for this query.installationId
- a site Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- installationId
is null
mandatory
- This method must be implemented. void clearInstallationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInstallationQuery()
InstallationQuery
is available for querying
installations. true
if an installation query is available,
false
otherwisemandatory
- This method must be implemented. SiteQuery getInstallationQuery()
OR
term.UnimplementedException
-
supportsInstallationQuery()
is false
optional
- This method must be implemented if
supportsInstallationQuery()
is true.
void matchAnyInstallation(boolean match)
match
- true
to match sites with any package,
false
to match sites with no packagesmandatory
- This method must be implemented. void clearInstallationTerms()
mandatory
- This method must be implemented. SiteQueryRecord getSiteQueryRecord(Type siteRecordType) throws OperationFailedException
Site
record Type.
Multiple retrievals produce a
nested OR
term.siteRecordType
- a site query record typeNullArgumentException
- siteRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(siteRecordType)
is false
mandatory
- This method must be implemented.