public interface EntryQuery extends OsidObjectQuery, OsidSourceableQuery
This is the query for searching entries. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearBlogIdTerms()
Clears the blog
Id terms. |
void |
clearBlogTerms()
Clears the blog terms.
|
void |
clearPosterIdTerms()
Clears the poster
Id terms. |
void |
clearPosterTerms()
Clears the poster terms.
|
void |
clearPostingAgentIdTerms()
Clears the posting agent
Id terms. |
void |
clearPostingAgentTerms()
Clears the posting agent terms.
|
void |
clearSubjectLineTerms()
Clears the subject line terms.
|
void |
clearSummaryTerms()
Clears the summary terms.
|
void |
clearTextTerms()
Clears the text terms.
|
void |
clearTimestampTerms()
Clears the timestamp terms.
|
BlogQuery |
getBlogQuery()
Gets the query for a blog.
|
EntryQueryRecord |
getEntryQueryRecord(Type entryRecordType)
Gets the query record corresponding to the given
Entry
record Type. |
ResourceQuery |
getPosterQuery()
Gets the query for a resource.
|
AgentQuery |
getPostingAgentQuery()
Gets the query for an agent.
|
void |
matchAnySubjectLine(boolean match)
Matches entries with any subject line.
|
void |
matchAnySummary(boolean match)
Matches entries with any summary.
|
void |
matchAnyText(boolean match)
Matches entries with any text.
|
void |
matchBlogId(Id blogId,
boolean match)
Sets the blog
Id for this query. |
void |
matchPosterId(Id resourceId,
boolean match)
Matches the poster of the entry.
|
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 |
matchSummary(java.lang.String summary,
Type stringMatchType,
boolean match)
Adds a summary 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 |
supportsBlogQuery()
Tests if a
BlogQuery is available. |
boolean |
supportsPosterQuery()
Tests if a
ResourceQuery is available for querying
posters. |
boolean |
supportsPostingAgentQuery()
Tests if an
AgentQuery is available for querying
senders. |
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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
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
- Id
of a Resource
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
- Id
of an Agent
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
senders. 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
- subject line 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 matchSummary(java.lang.String summary, Type stringMatchType, boolean match)
OR
among them.summary
- summary to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- summary is
not of stringMatchType
NullArgumentException
- summary
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnySummary(boolean match)
match
- true
to match entries with any summary,
false
to match entries with no summarymandatory
- This method must be implemented. void clearSummaryTerms()
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 matchBlogId(Id blogId, boolean match)
Id
for this query.blogId
- the blog Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- blogId
is
null
mandatory
- This method must be implemented. void clearBlogIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBlogQuery()
BlogQuery
is available. true
if a blog query is available, false
otherwisemandatory
- This method must be implemented. BlogQuery getBlogQuery()
OR
term.UnimplementedException
- supportsBlogQuery()
is false
optional
- This method must be implemented if
supportsBlogQuery()
is true.
void clearBlogTerms()
mandatory
- This method must be implemented. EntryQueryRecord getEntryQueryRecord(Type entryRecordType) throws OperationFailedException
Entry
record Type.
Multiple retrievals produce a nested
OR
term.entryRecordType
- an entry record typeNullArgumentException
- entryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(entryRecordType)
is false
mandatory
- This method must be implemented.