OSID - osid.billing.CustomerQuery Service Interface Definition

Interface	osid.billing.CustomerQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidTemporalQuery`
Used By	`osid.billing.BusinessQuery`
	`osid.billing.CustomerQuerySession`
	`osid.billing.CustomerSearchSession`
	`osid.billing.CustomerSmartBusinessSession`
	`osid.billing.EntryQuery`
	`osid.billing.payment.PayerQuery`
	`osid.billing.payment.PaymentQuery`
Description	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	matchResourceId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		a resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true`.
Method	clearResourceTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCustomerNumber
Description	Matches customer numbers.
Parameters	`string`	`number`	a customer number
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`number` not of `stringMatchType`
Errors	NULL_ARGUMENT		`number` or `stringMatchType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCustomerNumber
Description	Matches customers with any number.
Parameters	`boolean`	`match`	`true` to match customers with any number, `false` to match customers with no number
Compliance	`mandatory`		This method must be implemented.
Method	clearCustomerNumberTerms
Description	Clears the customer number.
Compliance	`mandatory`		This method must be implemented.
Method	matchActivityId
Description	Sets the activity `Id` for this query to match customers that have a financial activity.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityIdTerms
Description	Clears the activity `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityQuery
Description	Tests if an `ActivityQuery` is available.
Return	`boolean`		`true` if an activity query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityQuery
Description	Gets the query for an activity. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.ActivityQuery`		an activity query
Errors	UNIMPLEMENTED		`supportsActivityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityQuery()` is `true`.
Method	matchAnyActivity
Description	Matches customers that have any financial activity.
Parameters	`boolean`	`match`	`true` to match customers with any activity, `false` to match customers with no activity
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityTerms
Description	Clears the activity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match customers assigned to businesses.
Parameters	`osid.id.Id`	`businessId`	the business `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`businessId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBusinessIdTerms
Description	Clears the business `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessQuery
Description	Tests if a `BusinessQuery` is available.
Return	`boolean`		`true` if a business query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessQuery
Description	Gets the query for a business. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.BusinessQuery`		the business query
Errors	UNIMPLEMENTED		`supportsBusinessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBusinessQuery()` is `true`.
Method	clearBusinessTerms
Description	Clears the business terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerQueryRecord
Description	Gets the customer query record corresponding to the given `Customer` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`customerRecordType`	a customer record type
Return	`osid.billing.records.CustomerQueryRecord`		the customer query record
Errors	NULL_ARGUMENT		`customerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(customerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.