Interface TextQuery

All Superinterfaces:

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

public interface TextQuery
extends OsidObjectQuery

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

Like all OsidQueries, TextQuery is stateful and must not be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
void	clearPressIdTerms()	Clears the press Id query terms.
void	clearPressTerms()	Clears the press query terms.
void	clearTextReturnTerms()	Clears the text return query terms.
PressQuery	getPressQuery()	Gets the query for an press.
TextQueryRecord	getTextQueryRecord(Type textRecordType)	Gets the text query record corresponding to the given Text record Type.Multiple record retrievals produce a nested OR term.
void	matchPressId(Id pressId, boolean match)	Sets the press Id for this query to match texts assigned to presses.
boolean	supportsPressQuery()	Tests if a PressQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface 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 OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Details

clearTextReturnTerms

void clearTextReturnTerms()

Clears the text return query terms.

Compliance:

mandatory - This method must be implemented.

matchPressId

void matchPressId(Id pressId,
 boolean match)

Sets the press Id for this query to match texts assigned to presses.

Parameters:

pressId - the press Id

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

Throws:

NullArgumentException - pressId is null

Compliance:

mandatory - This method must be implemented.

clearPressIdTerms

void clearPressIdTerms()

Clears the press Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsPressQuery

boolean supportsPressQuery()

Tests if a PressQuery is available.

Returns:

true if an press query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPressQuery

PressQuery getPressQuery()

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

Returns:

the press query

Throws:

UnimplementedException - supportsPressQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPressQuery()} is {@code true}.

clearPressTerms

void clearPressTerms()

Clears the press query terms.

Compliance:

mandatory - This method must be implemented.

getTextQueryRecord

TextQueryRecord getTextQueryRecord(Type textRecordType)
                            throws OperationFailedException

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

Parameters:

textRecordType - a text record type

Returns:

the text query record

Throws:

NullArgumentException - textRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(textRecordType) is false

Compliance:

mandatory - This method must be implemented.