org.osid.search

Interface EngineQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface EngineQuery
extends OsidCatalogQuery

This is the query for searching for engines. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAncestorEngineIdTerms() Clears all ancestor engine Id terms.
void	clearAncestorEngineTerms() Clears all ancestor engine terms.
void	clearDescendantEngineIdTerms() Clears all descendant engine Id terms.
void	clearDescendantEngineTerms() Clears all descendant engine terms.
EngineQuery	getAncestorEngineQuery() Gets the query for an engine.
EngineQuery	getDescendantEngineQuery() Gets the query for an engine.
EngineQueryRecord	getEngineQueryRecord(Type engineRecordType) Gets the engine query record corresponding to the given Engine record Type.
void	matchAncestorEngineId(Id engineId, boolean match) Sets the engine Id for this query to match engines that have the specified engine as an ancestor.
void	matchAnyAncestorEngine(boolean match) Matches engines with any ancestor.
void	matchAnyDescendantEngine(boolean match) Matches engines with any descendant.
void	matchDescendantEngineId(Id engineId, boolean match) Sets the engine Id for this query to match engines that have the specified engine as a descendant.
boolean	supportsAncestorEngineQuery() Tests if an EngineQuery is available.
boolean	supportsDescendantEngineQuery() Tests if an EngineQuery is available.

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

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchAncestorEngineId

void matchAncestorEngineId(Id engineId,
                         boolean match)

Sets the engine Id for this query to match engines that have the specified engine as an ancestor.

Parameters:

engineId - an engine Id

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

Throws:

NullArgumentException - engineId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorEngineIdTerms

void clearAncestorEngineIdTerms()

Clears all ancestor engine Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorEngineQuery

boolean supportsAncestorEngineQuery()

Tests if an EngineQuery is available.

Returns:

true if an engine query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorEngineQuery

EngineQuery getAncestorEngineQuery()

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

Returns:

the engine query

Throws:

UnimplementedException - supportsAncestorEngineQuery() is false

Compliance:

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

matchAnyAncestorEngine

void matchAnyAncestorEngine(boolean match)

Matches engines with any ancestor.

Parameters:

match - true to match engine with any ancestor, false to match root engines

Compliance:

mandatory - This method must be implemented.

clearAncestorEngineTerms

void clearAncestorEngineTerms()

Clears all ancestor engine terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantEngineId

void matchDescendantEngineId(Id engineId,
                           boolean match)

Sets the engine Id for this query to match engines that have the specified engine as a descendant.

Parameters:

engineId - an engine Id

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

Throws:

NullArgumentException - engineId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantEngineIdTerms

void clearDescendantEngineIdTerms()

Clears all descendant engine Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantEngineQuery

boolean supportsDescendantEngineQuery()

Tests if an EngineQuery is available.

Returns:

true if an engine query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantEngineQuery

EngineQuery getDescendantEngineQuery()

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

Returns:

the engine query

Throws:

UnimplementedException - supportsDescendantEngineQuery() is false

Compliance:

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

matchAnyDescendantEngine

void matchAnyDescendantEngine(boolean match)

Matches engines with any descendant.

Parameters:

match - true to match engine with any descendant, false to match leaf engines

Compliance:

mandatory - This method must be implemented.

clearDescendantEngineTerms

void clearDescendantEngineTerms()

Clears all descendant engine terms.

Compliance:

mandatory - This method must be implemented.

getEngineQueryRecord

EngineQueryRecord getEngineQueryRecord(Type engineRecordType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets the engine query record corresponding to the given Engine record Type. Multiple record retrievals produce a nested boolean OR term.

Parameters:

engineRecordType - an engine record type

Returns:

the engine query record

Throws:

NullArgumentException - engineRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(engineRecordType) is false

Compliance:

mandatory - This method must be implemented.