OSID - osid.billing.BusinessQuery Service Interface Definition

Interface	osid.billing.BusinessQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching businesses. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchCustomerId
Description	Sets the customer `Id` for this query to match customers that have a related customer.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`customerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCustomerIdTerms
Description	Clears the customer `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerQuery
Description	Tests if a `CustomerQuery` is available.
Return	`boolean`		`true` if a customer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerQuery
Description	Gets the query for a customer. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.CustomerQuery`		the customer query
Errors	UNIMPLEMENTED		`supportsCustomerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCustomerQuery()` is `true.`
Method	matchAnyCustomer
Description	Matches businesses that have any customer.
Parameters	`boolean`	`match`	`true` to match customers with any customer, `false` to match customers with no customer
Compliance	`mandatory`		This method must be implemented.
Method	clearCustomerTerms
Description	Clears the customer query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchItemId
Description	Sets the item `Id` for this query.
Parameters	`osid.id.Id`	`itemId`	an item `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`itemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearItemIdTerms
Description	Clears the item `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemQuery
Description	Tests if an `ItemQuery` is available.
Return	`boolean`		`true` if an item query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getItemQuery
Description	Gets the query for an item. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.ItemQuery`		the item query
Errors	UNIMPLEMENTED		`supportsItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemQuery()` is `true.`
Method	matchAnyItem
Description	Matches businesses that have any item.
Parameters	`boolean`	`match`	`true` to match businesses with any item, `false` to match businesses with no items
Compliance	`mandatory`		This method must be implemented.
Method	clearItemTerms
Description	Clears the item query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCategoryId
Description	Sets the catalog `Id` for this query.
Parameters	`osid.id.Id`	`categoryId`	a category `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`categoryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCategoryIdTerms
Description	Clears the category `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategoryQuery
Description	Tests if a `CategoryQuery` is available.
Return	`boolean`		`true` if a category query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCategoryQuery
Description	Gets the query for a category. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.CategoryQuery`		the category query
Errors	UNIMPLEMENTED		`supportsCategoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCategoryQuery()` is `true.`
Method	matchAnyCategory
Description	Matches businesses that have any category.
Parameters	`boolean`	`match`	`true` to match customers with any category, `false` to match customers with no category
Compliance	`mandatory`		This method must be implemented.
Method	clearCategoryTerms
Description	Clears the category query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEntryId
Description	Sets the entry `Id` for this query.
Parameters	`osid.id.Id`	`itemId`	an entry `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`entryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEntryIdTerms
Description	Clears the entry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryQuery
Description	Tests if an `EntryQuery` is available.
Return	`boolean`		`true` if an entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntryQuery
Description	Gets the query for an entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.EntryQuery`		the entry query
Errors	UNIMPLEMENTED		`supportsEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryQuery()` is `true.`
Method	matchAnyEntry
Description	Matches businesses that have any entry.
Parameters	`boolean`	`match`	`true` to match businesses with any entry, `false` to match businesses with no entries
Compliance	`mandatory`		This method must be implemented.
Method	clearEntryTerms
Description	Clears the entry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPeriodId
Description	Sets the period `Id` for this query to match catalogs containing terms.
Parameters	`osid.id.Id`	`periodId`	the period `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`periodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPeriodIdTerms
Description	Clears the period `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodQuery
Description	Tests if a `PeriodQuery` is available.
Return	`boolean`		`true` if a period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodQuery
Description	Gets the query for a period Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.PeriodQuery`		the period query
Errors	UNIMPLEMENTED		`supportsPeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPeriodQuery()` is `true.`
Method	matchAnyPeriod
Description	Matches businesses that have any period.
Parameters	`boolean`	`match`	`true` to match businesses with any period, `false` to match customers with no period
Compliance	`mandatory`		This method must be implemented.
Method	clearPeriodTerms
Description	Clears the period query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorBusinessId
Description	Sets the business `Id` for this query to match businesses that have the specified business as an ancestor.
Parameters	`osid.id.Id`	`businessId`	a 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	clearAncestorBusinessIdTerms
Description	Clears the ancestor business `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorBusinessQuery
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	getAncestorBusinessQuery
Description	Gets the query for a business. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.BusinessQuery`		the business query
Errors	UNIMPLEMENTED		`supportsAncestorBusinessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorBusinessQuery()` is `true.`
Method	matchAnyAncestorBusiness
Description	Matches businesses with any business ancestor.
Parameters	`boolean`	`match`	`true` to match businesses with any ancestor, `false` to match root businesses
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBusinessTerms
Description	Clears the ancestor business query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantBusinessId
Description	Sets the business `Id` for this query to match businesses that have the specified business as an descendant.
Parameters	`osid.id.Id`	`businessId`	a 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	clearDescendantBusinessIdTerms
Description	Clears the descendant business `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantBusinessQuery
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	getDescendantBusinessQuery
Description	Gets the query for a business. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.BusinessQuery`		the business query
Errors	UNIMPLEMENTED		`supportsDescendantBusinessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantBusinessQuery()` is `true.`
Method	matchAnyDescendantBusiness
Description	Matches businesses with any descendant business.
Parameters	`boolean`	`match`	`true` to match businesses with any descendant, `false` to match leaf businesses
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBusinessTerms
Description	Clears the descendant business query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessQueryRecord
Description	Gets the business query record corresponding to the given `Business` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`businessRecordType`	a business record type
Return	`osid.billing.records.BusinessQueryRecord`		the business query record
Errors	NULL_ARGUMENT		`businessRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(businessRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.