org.osid.financials.posting

Interface PostEntryQuery

All Superinterfaces:

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

public interface PostEntryQuery
extends OsidObjectQuery, OsidSubjugateableQuery

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAccountIdTerms() Clears the account Id terms.
void	clearAccountTerms() Clears the account terms.
void	clearActivityIdTerms() Clears the activity Id terms.
void	clearActivityTerms() Clears the activity terms.
void	clearAmountTerms() Clears the amount terms.
void	clearBusinessIdTerms() Clears the business Id terms.
void	clearBusinessTerms() Clears the business terms.
void	clearDebitTerms() Clears the debit terms.
void	clearPostIdTerms() Clears the post Id terms.
void	clearPostTerms() Clears the post terms.
AccountQuery	getAccountQuery() Gets the query for an account.
ActivityQuery	getActivityQuery() Gets the query for an activity.
BusinessQuery	getBusinessQuery() Gets the query for a business.
PostEntryQueryRecord	getPostEntryQueryRecord(Type postEntryRecordType) Gets the post entry query record corresponding to the given PostEntry record Type.
PostQuery	getPostQuery() Gets the query for a post.
void	matchAccountId(Id accountId, boolean match) Sets the account Id for this query.
void	matchActivityId(Id activityId, boolean match) Sets the activity Id for this query.
void	matchAmount(Currency low, Currency high, boolean match) Matches the amount between the given range inclusive.
void	matchAnyAccount(boolean match) Matches entries that have any account set.
void	matchAnyActivity(boolean match) Matches entries that have any activity set.
void	matchAnyAmount(boolean match) Matches entries that have any amount set.
void	matchBusinessId(Id businessId, boolean match) Sets the business Id for this query to match post entries assigned to businesses.
void	matchDebit(boolean match) Matches entries that have debit amounts.
void	matchPostId(Id postId, boolean match) Sets the post Id for this query.
boolean	supportsAccountQuery() Tests if an AccountQuery is available.
boolean	supportsActivityQuery() Tests if an ActivityQuery is available.
boolean	supportsBusinessQuery() Tests if a BusinessQuery is available.
boolean	supportsPostQuery() Tests if a PostQuery is available.

Methods inherited from interface org.osid.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 org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchPostId

void matchPostId(Id postId,
               boolean match)

Sets the post Id for this query.

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.

clearPostIdTerms

void clearPostIdTerms()

Clears the post Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPostQuery

boolean supportsPostQuery()

Tests if a PostQuery is available.

Returns:

true if a post query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPostQuery

PostQuery getPostQuery()

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

Returns:

the post query

Throws:

UnimplementedException - supportsPostQuery() is false

Compliance:

optional - This method must be implemented if supportsPostQuery() is true.

clearPostTerms

void clearPostTerms()

Clears the post terms.

Compliance:

mandatory - This method must be implemented.

matchAccountId

void matchAccountId(Id accountId,
                  boolean match)

Sets the account Id for this query.

Parameters:

accountId - an account Id

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

Throws:

NullArgumentException - accountId is null

Compliance:

mandatory - This method must be implemented.

clearAccountIdTerms

void clearAccountIdTerms()

Clears the account Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAccountQuery

boolean supportsAccountQuery()

Tests if an AccountQuery is available.

Returns:

true if an account query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAccountQuery

AccountQuery getAccountQuery()

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

Returns:

the account query

Throws:

UnimplementedException - supportsAccountQuery() is false

Compliance:

optional - This method must be implemented if supportsAccountQuery() is true.

matchAnyAccount

void matchAnyAccount(boolean match)

Matches entries that have any account set.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAccountTerms

void clearAccountTerms()

Clears the account terms.

Compliance:

mandatory - This method must be implemented.

matchActivityId

void matchActivityId(Id activityId,
                   boolean match)

Sets the activity Id for this query.

Parameters:

activityId - an activity Id

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

Throws:

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActivityIdTerms

void clearActivityIdTerms()

Clears the activity Id terms.

Compliance:

mandatory - This method must be implemented.

supportsActivityQuery

boolean supportsActivityQuery()

Tests if an ActivityQuery is available.

Returns:

true if an activity query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityQuery

ActivityQuery getActivityQuery()

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

Returns:

the activity query

Throws:

UnimplementedException - supportsActivityQuery() is false

Compliance:

optional - This method must be implemented if supportsActivityQuery() is true.

matchAnyActivity

void matchAnyActivity(boolean match)

Matches entries that have any activity set.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearActivityTerms

void clearActivityTerms()

Clears the activity terms.

Compliance:

mandatory - This method must be implemented.

matchAmount

void matchAmount(Currency low,
               Currency high,
               boolean match)

Matches the amount 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.

matchAnyAmount

void matchAnyAmount(boolean match)

Matches entries that have any amount set.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAmountTerms

void clearAmountTerms()

Clears the amount terms.

Compliance:

mandatory - This method must be implemented.

matchDebit

void matchDebit(boolean match)

Matches entries that have debit amounts.

Parameters:

match - true to match entries with a debit amount, false to match entries with a credit amount

Compliance:

mandatory - This method must be implemented.

clearDebitTerms

void clearDebitTerms()

Clears the debit terms.

Compliance:

mandatory - This method must be implemented.

matchBusinessId

void matchBusinessId(Id businessId,
                   boolean match)

Sets the business Id for this query to match post entries 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 supportsBusinessQuery() is true.

clearBusinessTerms

void clearBusinessTerms()

Clears the business terms.

Compliance:

mandatory - This method must be implemented.

getPostEntryQueryRecord

PostEntryQueryRecord getPostEntryQueryRecord(Type postEntryRecordType)
                                             throws OperationFailedException

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

Parameters:

postEntryRecordType - a post entry record type

Returns:

the post entry query record

Throws:

NullArgumentException - postEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.