public interface ReplyQuery extends OsidObjectQuery, OsidContainableQuery, OsidSubjugateableQuery
This is the query for searching for replies. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearContainedReplyIdTerms()
Clears the contained reply
Id terms. |
void |
clearContainedReplyTerms()
Clears the contained reply terms.
|
void |
clearContainingReplyIdTerms()
Clears the containing reply
Id terms. |
void |
clearContainingReplyTerms()
Clears the containing reply terms.
|
void |
clearForumIdTerms()
Clears the forum
Id terms. |
void |
clearForumTerms()
Clears the forum terms.
|
void |
clearPosterIdTerms()
Clears the poster resource
Id terms. |
void |
clearPosterTerms()
Clears the poster terms.
|
void |
clearPostIdTerms()
Clears the post
Id terms. |
void |
clearPostingAgentIdTerms()
Clears the posting agent
Id terms. |
void |
clearPostingAgentTerms()
Clears the posting agent terms.
|
void |
clearPostTerms()
Clears the post terms.
|
void |
clearSubjectLineTerms()
Clears the subject line terms.
|
void |
clearTextTerms()
Clears the text terms.
|
void |
clearTimestampTerms()
Clears the timestamp terms.
|
ReplyQuery |
getContainedReplyQuery()
Gets the query for a contained reply.
|
ReplyQuery |
getContainingReplyQuery()
Gets the query for a containing reply.
|
ForumQuery |
getForumQuery()
Gets the query for a forum query.
|
ResourceQuery |
getPosterQuery()
Gets the query for a resource.
|
AgentQuery |
getPostingAgentQuery()
Gets the query for an agent.
|
PostQuery |
getPostQuery()
Gets the query for a post query.
|
ReplyQueryRecord |
getReplyQueryRecord(Type replyRecordType)
Gets the reply query record corresponding to the given
Reply
record Type. |
void |
matchAnyContainedReply(boolean match)
Matches replies with any descednant reply.
|
void |
matchAnyContainingReply(boolean match)
Matches replies with any ancestor reply.
|
void |
matchAnySubjectLine(boolean match)
Matches entries with any subject line.
|
void |
matchAnyText(boolean match)
Matches entries with any text.
|
void |
matchContainedReplyId(Id replyId,
boolean match)
Sets the reply
Id for this query to match replies that
have the specified reply as a descendant. |
void |
matchContainingReplyId(Id replyId,
boolean match)
Sets the reply
Id for this query to match replies that
have the specified reply as an ancestor. |
void |
matchForumId(Id forumId,
boolean match)
Sets the post
Id for this query to match replies
assigned to forums. |
void |
matchPosterId(Id resourceId,
boolean match)
Matches the poster of the entry.
|
void |
matchPostId(Id postId,
boolean match)
Sets the post
Id for this query to match replies to
posts. |
void |
matchPostingAgentId(Id agentId,
boolean match)
Matches the posting agent of the entry.
|
void |
matchSubjectLine(java.lang.String subject,
Type stringMatchType,
boolean match)
Adds a subject line to match.
|
void |
matchText(java.lang.String text,
Type stringMatchType,
boolean match)
Adds text to match.
|
void |
matchTimestamp(DateTime startTime,
DateTime endTime,
boolean match)
Matches entries whose sent time is between the supplied range
inclusive.
|
boolean |
supportsContainedReplyQuery()
Tests if a contained reply query is available.
|
boolean |
supportsContainingReplyQuery()
Tests if a containing reply query is available.
|
boolean |
supportsForumQuery()
Tests if a
ForumQuery is available. |
boolean |
supportsPosterQuery()
Tests if a
ResourceQuery is available for querying
posters. |
boolean |
supportsPostingAgentQuery()
Tests if an
AgentQuery is available for querying
posting agents. |
boolean |
supportsPostQuery()
Tests if a
PostQuery is available. |
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
clearSequesteredTerms, matchSequestered
void matchPostId(Id postId, boolean match)
Id
for this query to match replies to
posts.postId
- a post Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- postId
is
null
mandatory
- This method must be implemented. void clearPostIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsPostQuery()
PostQuery
is available. true
if a post query is available, false
otherwisemandatory
- This method must be implemented. PostQuery getPostQuery()
OR
term.UnimplementedException
- supportsPostQuery()
is false
optional
- This method must be implemented if
supportsPostQuery()
is true.
void clearPostTerms()
mandatory
- This method must be implemented. void matchTimestamp(DateTime startTime, DateTime endTime, boolean match)
startTime
- start timeendTime
- end timematch
- true
if for a positive match,
false
for a negative matchInvalidArgumentException
- startTime
is
greater than endTime
NullArgumentException
- startTime
or
endTime
is null
mandatory
- This method must be implemented. void clearTimestampTerms()
mandatory
- This method must be implemented. void matchPosterId(Id resourceId, boolean match)
resourceId
- resource Id
to matchmatch
- true
if for a positive match,
false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearPosterIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsPosterQuery()
ResourceQuery
is available for querying
posters. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getPosterQuery()
UnimplementedException
- supportsPosterQuery()
is false
optional
- This method must be implemented if
supportsPosterQuery()
is true.
void clearPosterTerms()
mandatory
- This method must be implemented. void matchPostingAgentId(Id agentId, boolean match)
agentId
- agent Id
to matchmatch
- true
if for a positive match,
false
for a negative matchNullArgumentException
- agentId
is
null
mandatory
- This method must be implemented. void clearPostingAgentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsPostingAgentQuery()
AgentQuery
is available for querying
posting agents. true
if an agent query is available,
false
otherwisemandatory
- This method must be implemented. AgentQuery getPostingAgentQuery()
UnimplementedException
-
supportsPostingAgentQuery()
is false
optional
- This method must be implemented if
supportsPostingAgentQuery()
is true.
void clearPostingAgentTerms()
mandatory
- This method must be implemented. void matchSubjectLine(java.lang.String subject, Type stringMatchType, boolean match)
OR
among them.subject
- display name to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- subject is
not of stringMatchType
NullArgumentException
- subject
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnySubjectLine(boolean match)
match
- true
to match entries with any subject
line, false
to match entries with no subject
linemandatory
- This method must be implemented. void clearSubjectLineTerms()
mandatory
- This method must be implemented. void matchText(java.lang.String text, Type stringMatchType, boolean match)
OR
among them.text
- text to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- text is
not
of stringMatchType
NullArgumentException
- text
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyText(boolean match)
match
- true
to match entries with any text,
false
to match entries with no textmandatory
- This method must be implemented. void clearTextTerms()
mandatory
- This method must be implemented. void matchContainingReplyId(Id replyId, boolean match)
Id
for this query to match replies that
have the specified reply as an ancestor.replyId
- a reply Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- replyId
is
null
mandatory
- This method must be implemented. void clearContainingReplyIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsContainingReplyQuery()
true
if a containing reply query is available,
false
otherwisemandatory
- This method must be implemented. ReplyQuery getContainingReplyQuery()
UnimplementedException
-
supportsContainingReplyQuery()
is false
optional
- This method must be implemented if
supportsContainingReplyQuery()
is true.
void matchAnyContainingReply(boolean match)
match
- true
to match replies with any ancestor
reply, false
to match replies with no ancestor
repliesmandatory
- This method must be implemented. void clearContainingReplyTerms()
mandatory
- This method must be implemented. void matchContainedReplyId(Id replyId, boolean match)
Id
for this query to match replies that
have the specified reply as a descendant.replyId
- a reply Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- replyId
is
null
mandatory
- This method must be implemented. void clearContainedReplyIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsContainedReplyQuery()
true
if a contained reply query is available,
false
otherwisemandatory
- This method must be implemented. ReplyQuery getContainedReplyQuery()
UnimplementedException
-
supportsContainedReplyQuery()
is false
optional
- This method must be implemented if
supportsContainedReplyQuery()
is true.
void matchAnyContainedReply(boolean match)
match
- true
to match replies with any descendant
reply, false
to match replies with no
descendant repliesmandatory
- This method must be implemented. void clearContainedReplyTerms()
mandatory
- This method must be implemented. void matchForumId(Id forumId, boolean match)
Id
for this query to match replies
assigned to forums.forumId
- a forum Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- forumId
is
null
mandatory
- This method must be implemented. void clearForumIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsForumQuery()
ForumQuery
is available. true
if a forum query is available,
false
otherwisemandatory
- This method must be implemented. ForumQuery getForumQuery()
OR
term.UnimplementedException
- supportsForumQuery()
is false
optional
- This method must be implemented if
supportsForumQuery()
is true.
void clearForumTerms()
mandatory
- This method must be implemented. ReplyQueryRecord getReplyQueryRecord(Type replyRecordType) throws OperationFailedException
Reply
record Type.
Multiple record retrievals produce
a nested OR
term.replyRecordType
- a reply record typeNullArgumentException
- replyRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(replyRecordType)
is false
mandatory
- This method must be implemented.