Interface ItemQuery

All Superinterfaces:

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

public interface ItemQuery
extends OsidObjectQuery

This is the query for searching items. 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	clearAccountIdTerms()	Clears the account Id terms.
void	clearAccountTerms()	Clears the account terms.
void	clearAmountTerms()	Clears the amount terms.
void	clearBusinessIdTerms()	Clears the business Id terms.
void	clearBusinessTerms()	Clears the business terms.
void	clearCategoryIdTerms()	Clears the category Id terms.
void	clearCategoryTerms()	Clears the category terms.
void	clearDebitTerms()	Clears the debit terms.
void	clearEntryIdTerms()	Clears the entry Id terms.
void	clearEntryTerms()	Clears the entry terms.
void	clearProductIdTerms()	Clears the account Id terms.
void	clearProductTerms()	Clears the product terms.
void	clearRecurringIntervalTerms()	Clears the amount terms.
AccountQuery	getAccountQuery()	Gets the query for an account.
BusinessQuery	getBusinessQuery()	Gets the query for a business.
CategoryQuery	getCategoryQuery()	Gets the query for a category.
EntryQuery	getEntryQuery()	Gets the query for an entry.
ItemQueryRecord	getItemQueryRecord(Type itemRecordType)	Gets the item query record corresponding to the given Customer record Type .Multiple record retrievals produce a nested OR term.
ProductQuery	getProductQuery()	Gets the query for a product.
void	matchAccountId(Id accountId, boolean match)	Sets the account Id for this query to match items that have a related financial account.
void	matchAmount(Currency low, Currency high, boolean match)	Matches the amount between the given range inclusive.
void	matchAnyAccount(boolean match)	Matches items that have any account.
void	matchAnyAmount(boolean match)	Matches items that have any amount set.
void	matchAnyEntry(boolean match)	Matches items that have any entry.
void	matchAnyProduct(boolean match)	Matches items that have any product.
void	matchAnyRecurringInterval(boolean match)	Matches items that have any recurring interval.
void	matchBusinessId(Id businessId, boolean match)	Sets the business Id for this query to match customers assigned to businesses.
void	matchCategoryId(Id categoryId, boolean match)	Sets the category Id for this query.
void	matchDebit(boolean match)	Matches items that have debit amounts.
void	matchEntryId(Id entryId, boolean match)	Sets the entry Id for this query to match items that have a related entry.
void	matchProductId(Id productId, boolean match)	Sets the product Id for this query to match items that have a related product.
void	matchRecurringInterval(Duration low, Duration high, boolean match)	Matches the recurring interval between the given range inclusive.
boolean	supportsAccountQuery()	Tests if an AccountQuery is available.
boolean	supportsBusinessQuery()	Tests if a BusinessQuery is available.
boolean	supportsCategoryQuery()	Tests if a CategoryQuery is available.
boolean	supportsEntryQuery()	Tests if an EntryQuery is available.
boolean	supportsProductQuery()	Tests if a ProductQuery is available.

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

matchCategoryId

void matchCategoryId(Id categoryId,
 boolean match)

Sets the category Id for this query.

Parameters:

categoryId - a category Id

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

Throws:

NullArgumentException - categoryId is null

Compliance:

mandatory - This method must be implemented.

clearCategoryIdTerms

void clearCategoryIdTerms()

Clears the category Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCategoryQuery

boolean supportsCategoryQuery()

Tests if a CategoryQuery is available.

Returns:

true if a category query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCategoryQuery

CategoryQuery getCategoryQuery()

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

Returns:

a category query

Throws:

UnimplementedException - supportsCategoryQuery() is false

Compliance:

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

clearCategoryTerms

void clearCategoryTerms()

Clears the category terms.

Compliance:

mandatory - This method must be implemented.

matchAccountId

void matchAccountId(Id accountId,
 boolean match)

Sets the account Id for this query to match items that have a related financial account.

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 {@code supportsAccountQuery()} is {@code true} .

matchAnyAccount

void matchAnyAccount(boolean match)

Matches items that have any account.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAccountTerms

void clearAccountTerms()

Clears the account terms.

Compliance:

mandatory - This method must be implemented.

matchProductId

void matchProductId(Id productId,
 boolean match)

Sets the product Id for this query to match items that have a related product.

Parameters:

productId - a product Id

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

Throws:

NullArgumentException - productId is null

Compliance:

mandatory - This method must be implemented.

clearProductIdTerms

void clearProductIdTerms()

Clears the account Id terms.

Compliance:

mandatory - This method must be implemented.

supportsProductQuery

boolean supportsProductQuery()

Tests if a ProductQuery is available.

Returns:

true if a product query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProductQuery

ProductQuery getProductQuery()

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

Returns:

the product query

Throws:

UnimplementedException - supportsProductQuery() is false

Compliance:

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

matchAnyProduct

void matchAnyProduct(boolean match)

Matches items that have any product.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearProductTerms

void clearProductTerms()

Clears the product 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 items that have any amount set.

Parameters:

match - true to match items with any amount, false to match items 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 items that have debit amounts.

Parameters:

match - true to match items with a debit amount, false to match items 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.

matchRecurringInterval

void matchRecurringInterval(Duration low,
 Duration high,
 boolean match)

Matches the recurring interval 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.

matchAnyRecurringInterval

void matchAnyRecurringInterval(boolean match)

Matches items that have any recurring interval.

Parameters:

match - true to match items with any recurring interval, false to match items with a one-time charge

Compliance:

mandatory - This method must be implemented.

clearRecurringIntervalTerms

void clearRecurringIntervalTerms()

Clears the amount terms.

Compliance:

mandatory - This method must be implemented.

matchEntryId

void matchEntryId(Id entryId,
 boolean match)

Sets the entry Id for this query to match items that have a related entry.

Parameters:

entryId - an entry Id

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

Throws:

NullArgumentException - entryId is null

Compliance:

mandatory - This method must be implemented.

clearEntryIdTerms

void clearEntryIdTerms()

Clears the entry Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEntryQuery

boolean supportsEntryQuery()

Tests if an EntryQuery is available.

Returns:

true if an entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEntryQuery

EntryQuery getEntryQuery()

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

Returns:

the entry query

Throws:

UnimplementedException - supportsEntryQuery() is false

Compliance:

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

matchAnyEntry

void matchAnyEntry(boolean match)

Matches items that have any entry.

Parameters:

match - true to match items with any entry. false to match items with no entry

Compliance:

mandatory - This method must be implemented.

clearEntryTerms

void clearEntryTerms()

Clears the entry terms.

Compliance:

mandatory - This method must be implemented.

matchBusinessId

void matchBusinessId(Id businessId,
 boolean match)

Sets the business Id for this query to match customers 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.

getItemQueryRecord

ItemQueryRecord getItemQueryRecord(Type itemRecordType)
                            throws OperationFailedException

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

Parameters:

itemRecordType - an item record type

Returns:

the item query record

Throws:

NullArgumentException - itemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(itemRecordType) is false

Compliance:

mandatory - This method must be implemented.