org.osid.billing

Interface CustomerQuery

All Superinterfaces:

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

public interface CustomerQuery
extends OsidObjectQuery, OsidTemporalQuery

This is the query for searching customers. 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	clearActivityIdTerms() Clears the activity Id terms.
void	clearActivityTerms() Clears the activity terms.
void	clearBusinessIdTerms() Clears the business Id terms.
void	clearBusinessTerms() Clears the business terms.
void	clearCustomerNumberTerms() Clears the customer number.
void	clearResourceIdTerms() Clears the resource Id terms.
void	clearResourceTerms() Clears the resource terms.
ActivityQuery	getActivityQuery() Gets the query for an activity.
BusinessQuery	getBusinessQuery() Gets the query for a business.
CustomerQueryRecord	getCustomerQueryRecord(Type customerRecordType) Gets the customer query record corresponding to the given Customer record Type.
ResourceQuery	getResourceQuery() Gets the query for a resource.
void	matchActivityId(Id activityId, boolean match) Sets the activity Id for this query to match customers that have a financial activity.
void	matchAnyActivity(boolean match) Matches customers that have any financial activity.
void	matchAnyCustomerNumber(boolean match) Matches customers with any number.
void	matchBusinessId(Id businessId, boolean match) Sets the business Id for this query to match customers assigned to businesses.
void	matchCustomerNumber(java.lang.String number, Type stringMatchType, boolean match) Matches customer numbers.
void	matchResourceId(Id resourceId, boolean match) Sets the resource Id for this query.
boolean	supportsActivityQuery() Tests if an ActivityQuery is available.
boolean	supportsBusinessQuery() Tests if a BusinessQuery is available.
boolean	supportsResourceQuery() Tests if a ResourceQuery 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

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchResourceId

void matchResourceId(Id resourceId,
                   boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResourceIdTerms

void clearResourceIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

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

Returns:

a resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

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

clearResourceTerms

void clearResourceTerms()

Clears the resource terms.

Compliance:

mandatory - This method must be implemented.

matchCustomerNumber

void matchCustomerNumber(java.lang.String number,
                       Type stringMatchType,
                       boolean match)

Matches customer numbers.

Parameters:

number - a customer number

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - number not of stringMatchType

NullArgumentException - number or stringMatchType is null

Compliance:

mandatory - This method must be implemented.

matchAnyCustomerNumber

void matchAnyCustomerNumber(boolean match)

Matches customers with any number.

Parameters:

match - true to match customers with any number, false to match customers with no number

Compliance:

mandatory - This method must be implemented.

clearCustomerNumberTerms

void clearCustomerNumberTerms()

Clears the customer number.

Compliance:

mandatory - This method must be implemented.

matchActivityId

void matchActivityId(Id activityId,
                   boolean match)

Sets the activity Id for this query to match customers that have a financial activity.

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:

an activity query

Throws:

UnimplementedException - supportsActivityQuery() is false

Compliance:

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

matchAnyActivity

void matchAnyActivity(boolean match)

Matches customers that have any financial activity.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearActivityTerms

void clearActivityTerms()

Clears the activity 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 supportsBusinessQuery() is true.

clearBusinessTerms

void clearBusinessTerms()

Clears the business terms.

Compliance:

mandatory - This method must be implemented.

getCustomerQueryRecord

CustomerQueryRecord getCustomerQueryRecord(Type customerRecordType)
                                           throws OperationFailedException

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

Parameters:

customerRecordType - a customer record type

Returns:

the customer query record

Throws:

NullArgumentException - customerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(customerRecordType) is false

Compliance:

mandatory - This method must be implemented.