OSID - osid.financials.BusinessQuery Service Interface Definition

Interface	osid.financials.BusinessQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.financials.AccountQuery`
	`osid.financials.ActivityQuery`
	`osid.financials.BusinessQuery`
	`osid.financials.BusinessQuerySession`
	`osid.financials.BusinessSearchSession`
	`osid.financials.FiscalPeriodQuery`
	`osid.financials.budgeting.BudgetEntryQuery`
	`osid.financials.budgeting.BudgetQuery`
	`osid.financials.posting.PostEntryQuery`
	`osid.financials.posting.PostQuery`
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	matchAccountId
Description	Sets the account `Id` for this query.
Parameters	`osid.id.Id`	`accountId`	an account `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`accountId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAccountIdTerms
Description	Clears the account `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountQuery
Description	Tests if an `AccountQuery` is available.
Return	`boolean`		`true` if an account query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAccountQuery
Description	Gets the query for an account. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.AccountQuery`		the account query
Errors	UNIMPLEMENTED		`supportsAccountQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAccountQuery()` is `true` .
Method	matchAnyAccount
Description	Matches businesses that have any account.
Parameters	`boolean`	`match`	`true` to match businesses with any account, `false` to match businesses with no accounts
Compliance	`mandatory`		This method must be implemented.
Method	clearAccountTerms
Description	Clears the account query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActivityId
Description	Sets the activity `Id` for this query.
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` query 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`		the activity query
Errors	UNIMPLEMENTED		`supportsActivityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityQuery()` is `true` .
Method	matchAnyActivity
Description	Matches businesses that have any activity.
Parameters	`boolean`	`match`	`true` to match businesses with any activity, `false` to match businesses with no activities
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityTerms
Description	Clears the activity query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFiscalPeriodId
Description	Sets the fiscal period `Id` for this query.
Parameters	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`fiscalPeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFiscalPeriodIdTerms
Description	Clears the fiscal period `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodQuery
Description	Tests if a `FiscalPeriodQuery` is available.
Return	`boolean`		`true` if a fiscal period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodQuery
Description	Gets the query for a fiscal period. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.FiscalPeriodQuery`		the fiscal period query
Errors	UNIMPLEMENTED		`supportsFiscalPeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFiscalPeriodQuery()` is `true` .
Method	matchAnyFiscalPeriod
Description	Matches businesses that have any fiscal period.
Parameters	`boolean`	`match`	`true` to match businesses with any fiscal period, `false` to match businesses with no fiscal period
Compliance	`mandatory`		This method must be implemented.
Method	clearFiscalPeriodTerms
Description	Clears the fiscal 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.financials.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 a 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.financials.BusinessQuery`		the business query
Errors	UNIMPLEMENTED		`supportsDescendantBusinessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantBusinessQuery()` is `true` .
Method	matchAnyDescendantBusiness
Description	Matches agencies 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.financials.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.