Interface PostQuery

All Superinterfaces:

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

public interface PostQuery
extends OsidObjectQuery, OsidAggregateableQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearBusinessIdTerms()	Clears the business Id terms.
void	clearBusinessTerms()	Clears the business terms.
void	clearCorrectedPostIdTerms()	Clears the corrected post Id terms.
void	clearCorrectedPostTerms()	Clears the corrected post terms.
void	clearDateTerms()	Clears the date terms.
void	clearFiscalPeriodIdTerms()	Clears the fiscal period Id terms.
void	clearFiscalPeriodTerms()	Clears the fiscal period terms.
void	clearPostedTerms()	Clears the posted terms.
void	clearPostEntryIdTerms()	Clears the post entry Id terms.
void	clearPostEntryTerms()	Clears the post entry terms.
BusinessQuery	getBusinessQuery()	Gets the query for a business.
PostQuery	getCorrectedPostQuery()	Gets the query for a corrected posts.
FiscalPeriodQuery	getFiscalPeriodQuery()	Gets the query for a fiscal period.
PostEntryQuery	getPostEntryQuery()	Gets the query for a post entries.
PostQueryRecord	getPostQueryRecord(Type postRecordType)	Gets the post query record corresponding to the given Post record Type .Multiple record retrievals produce a nested OR term.
void	matchAnyCorrectedPost(boolean match)	Matches any posts with corrected posts.
void	matchAnyDate(boolean match)	Matches items that have any date set.
void	matchAnyFiscalPeriod(boolean match)	Matches any fiscal period.
void	matchAnyPostEntry(boolean match)	Matches any posts with post entries.
void	matchBusinessId(Id businessId, boolean match)	Sets the business Id for this query to match posts assigned to businesses.
void	matchCorrectedPostId(Id postId, boolean match)	Sets the post entry Id for this query to match posts that have a corrected post.
void	matchDate(DateTime low, DateTime high, boolean match)	Matches the date between the given range inclusive.
void	matchFiscalPeriodId(Id fiscalPeriodId, boolean match)	Sets the fiscal period Id for this query.
void	matchPosted(boolean match)	Matches posts that have been posted.
void	matchPostEntryId(Id postEntryId, boolean match)	Sets the post entry Id for this query to match posts that have a related post entries.
boolean	supportsBusinessQuery()	Tests if a BusinessQuery is available.
boolean	supportsCorrectedPostQuery()	Tests if a PostQuery is available.
boolean	supportsFiscalPeriodQuery()	Tests if a FiscalPeriod is available.
boolean	supportsPostEntryQuery()	Tests if a PostEntryQuery is available for the location.

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.

Method Details

matchFiscalPeriodId

void matchFiscalPeriodId(Id fiscalPeriodId,
 boolean match)

Sets the fiscal period Id for this query.

Parameters:

fiscalPeriodId - a fiscal period Id

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

Throws:

NullArgumentException - foscalPeriodId is null

Compliance:

mandatory - This method must be implemented.

clearFiscalPeriodIdTerms

void clearFiscalPeriodIdTerms()

Clears the fiscal period Id terms.

Compliance:

mandatory - This method must be implemented.

supportsFiscalPeriodQuery

boolean supportsFiscalPeriodQuery()

Tests if a FiscalPeriod is available.

Returns:

true if a fiscal period query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodQuery

FiscalPeriodQuery getFiscalPeriodQuery()

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

Returns:

the fiscal period query

Throws:

UnimplementedException - supportsFiscalPeriodQuery() is false

Compliance:

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

matchAnyFiscalPeriod

void matchAnyFiscalPeriod(boolean match)

Matches any fiscal period.

Parameters:

match - true to match posts with any fiscal period, false to match posts with no fiscal period

Compliance:

mandatory - This method must be implemented.

clearFiscalPeriodTerms

void clearFiscalPeriodTerms()

Clears the fiscal period terms.

Compliance:

mandatory - This method must be implemented.

matchPosted

void matchPosted(boolean match)

Matches posts that have been posted.

Parameters:

match - true to match posted posts false to match unposted posts

Compliance:

mandatory - This method must be implemented.

clearPostedTerms

void clearPostedTerms()

Clears the posted terms.

Compliance:

mandatory - This method must be implemented.

matchDate

void matchDate(DateTime low,
 DateTime high,
 boolean match)

Matches the date between the given range inclusive.

Parameters:

low - start of range

high - end of range

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

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

matchAnyDate

void matchAnyDate(boolean match)

Matches items that have any date set.

Parameters:

match - true to match items with any date, false to match items with no date

Compliance:

mandatory - This method must be implemented.

clearDateTerms

void clearDateTerms()

Clears the date terms.

Compliance:

mandatory - This method must be implemented.

matchPostEntryId

void matchPostEntryId(Id postEntryId,
 boolean match)

Sets the post entry Id for this query to match posts that have a related post entries.

Parameters:

postEntryId - a post entry Id

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

Throws:

NullArgumentException - postEntryId is null

Compliance:

mandatory - This method must be implemented.

clearPostEntryIdTerms

void clearPostEntryIdTerms()

Clears the post entry Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPostEntryQuery

boolean supportsPostEntryQuery()

Tests if a PostEntryQuery is available for the location.

Returns:

true if a post entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPostEntryQuery

PostEntryQuery getPostEntryQuery()

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

Returns:

the post entry query

Throws:

UnimplementedException - supportsPostEntryQuery() is false

Compliance:

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

matchAnyPostEntry

void matchAnyPostEntry(boolean match)

Matches any posts with post entries.

Parameters:

match - true to match posts with any post entry, false to match posts with no entries

Compliance:

mandatory - This method must be implemented.

clearPostEntryTerms

void clearPostEntryTerms()

Clears the post entry terms.

Compliance:

mandatory - This method must be implemented.

matchCorrectedPostId

void matchCorrectedPostId(Id postId,
 boolean match)

Sets the post entry Id for this query to match posts that have a corrected post.

Parameters:

postId - a post Id

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

Throws:

NullArgumentException - postId is null

Compliance:

mandatory - This method must be implemented.

clearCorrectedPostIdTerms

void clearCorrectedPostIdTerms()

Clears the corrected post Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCorrectedPostQuery

boolean supportsCorrectedPostQuery()

Tests if a PostQuery is available.

Returns:

true if a post query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCorrectedPostQuery

PostQuery getCorrectedPostQuery()

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

Returns:

the post query

Throws:

UnimplementedException - supportsCorrectedPostQuery() is false

Compliance:

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

matchAnyCorrectedPost

void matchAnyCorrectedPost(boolean match)

Matches any posts with corrected posts.

Parameters:

match - true to match posts with any corrected post, false to match posts with no corrected posts

Compliance:

mandatory - This method must be implemented.

clearCorrectedPostTerms

void clearCorrectedPostTerms()

Clears the corrected post terms.

Compliance:

mandatory - This method must be implemented.

matchBusinessId

void matchBusinessId(Id businessId,
 boolean match)

Sets the business Id for this query to match posts assigned to businesses.

Parameters:

businessId - the business Id

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

Throws:

NullArgumentException - businessId is null

Compliance:

mandatory - This method must be implemented.

clearBusinessIdTerms

void clearBusinessIdTerms()

Clears the business Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBusinessQuery

boolean supportsBusinessQuery()

Tests if a BusinessQuery is available.

Returns:

true if a business query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBusinessQuery

BusinessQuery getBusinessQuery()

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

Returns:

the business query

Throws:

UnimplementedException - supportsBusinessQuery() is false

Compliance:

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

clearBusinessTerms

void clearBusinessTerms()

Clears the business terms.

Compliance:

mandatory - This method must be implemented.

getPostQueryRecord

PostQueryRecord getPostQueryRecord(Type postRecordType)
                            throws OperationFailedException

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

Parameters:

postRecordType - a post record type

Returns:

the post query record

Throws:

NullArgumentException - postRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postRecordType) is false

Compliance:

mandatory - This method must be implemented.