Interface EntryQuery

All Superinterfaces:

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

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 .

Method Summary

Modifier and Type	Method	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 .Multiple retrievals produce a nested OR term.
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(String subject, Type stringMatchType, boolean match)	Adds a subject line to match.
void	matchSummary(String summary, Type stringMatchType, boolean match)	Adds a summary to match.
void	matchText(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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

matchTimestamp

void matchTimestamp(DateTime startTime,
 DateTime endTime,
 boolean match)

Matches entries whose sent time is between the supplied range inclusive.

Parameters:

startTime - start time

endTime - end time

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

Throws:

InvalidArgumentException - startTime is greater than endTime

NullArgumentException - startTime or endTime is null

Compliance:

mandatory - This method must be implemented.

clearTimestampTerms

void clearTimestampTerms()

Clears the timestamp terms.

Compliance:

mandatory - This method must be implemented.

matchPosterId

void matchPosterId(Id resourceId,
 boolean match)

Matches the poster of the entry.

Parameters:

resourceId - Id of a Resource to match

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearPosterIdTerms

void clearPosterIdTerms()

Clears the poster Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPosterQuery

boolean supportsPosterQuery()

Tests if a ResourceQuery is available for querying posters.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPosterQuery

ResourceQuery getPosterQuery()

Gets the query for a resource.

Returns:

the resource query

Throws:

UnimplementedException - supportsPosterQuery() is false

Compliance:

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

clearPosterTerms

void clearPosterTerms()

Clears the poster terms.

Compliance:

mandatory - This method must be implemented.

matchPostingAgentId

void matchPostingAgentId(Id agentId,
 boolean match)

Matches the posting agent of the entry.

Parameters:

agentId - Id of an Agent to match

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

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearPostingAgentIdTerms

void clearPostingAgentIdTerms()

Clears the posting agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPostingAgentQuery

boolean supportsPostingAgentQuery()

Tests if an AgentQuery is available for querying senders.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPostingAgentQuery

AgentQuery getPostingAgentQuery()

Gets the query for an agent.

Returns:

the agent query

Throws:

UnimplementedException - supportsPostingAgentQuery() is false

Compliance:

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

clearPostingAgentTerms

void clearPostingAgentTerms()

Clears the posting agent terms.

Compliance:

mandatory - This method must be implemented.

matchSubjectLine

void matchSubjectLine(String subject,
 Type stringMatchType,
 boolean match)

Adds a subject line to match. Multiple subject line matches can be added to perform a boolean OR among them.

Parameters:

subject - subject line to match

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - subject is not of stringMatchType

NullArgumentException - subject or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnySubjectLine

void matchAnySubjectLine(boolean match)

Matches entries with any subject line.

Parameters:

match - true to match entries with any subject line, false to match entries with no subject line

Compliance:

mandatory - This method must be implemented.

clearSubjectLineTerms

void clearSubjectLineTerms()

Clears the subject line terms.

Compliance:

mandatory - This method must be implemented.

matchSummary

void matchSummary(String summary,
 Type stringMatchType,
 boolean match)

Adds a summary to match. Multiple summaries matches can be added to perform a boolean OR among them.

Parameters:

summary - summary to match

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - summary is not of stringMatchType

NullArgumentException - summary or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnySummary

void matchAnySummary(boolean match)

Matches entries with any summary.

Parameters:

match - true to match entries with any summary, false to match entries with no summary

Compliance:

mandatory - This method must be implemented.

clearSummaryTerms

void clearSummaryTerms()

Clears the summary terms.

Compliance:

mandatory - This method must be implemented.

matchText

void matchText(String text,
 Type stringMatchType,
 boolean match)

Adds text to match. Multiple text matches can be added to perform a boolean OR among them.

Parameters:

text - text to match

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - text is not of stringMatchType

NullArgumentException - text or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyText

void matchAnyText(boolean match)

Matches entries with any text.

Parameters:

match - true to match entries with any text, false to match entries with no text

Compliance:

mandatory - This method must be implemented.

clearTextTerms

void clearTextTerms()

Clears the text terms.

Compliance:

mandatory - This method must be implemented.

matchBlogId

void matchBlogId(Id blogId,
 boolean match)

Sets the blog Id for this query.

Parameters:

blogId - the blog Id

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

Throws:

NullArgumentException - blogId is null

Compliance:

mandatory - This method must be implemented.

clearBlogIdTerms

void clearBlogIdTerms()

Clears the blog Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBlogQuery

boolean supportsBlogQuery()

Tests if a BlogQuery is available.

Returns:

true if a blog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBlogQuery

BlogQuery getBlogQuery()

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

Returns:

the blog query

Throws:

UnimplementedException - supportsBlogQuery() is false

Compliance:

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

clearBlogTerms

void clearBlogTerms()

Clears the blog terms.

Compliance:

mandatory - This method must be implemented.

getEntryQueryRecord

EntryQueryRecord getEntryQueryRecord(Type entryRecordType)
                              throws OperationFailedException

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

Parameters:

entryRecordType - an entry record type

Returns:

the entry query record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.