OSID - osid.financials.budgeting.BudgetQuery Service Interface Definition

Interface	osid.financials.budgeting.BudgetQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.financials.budgeting.BudgetEntryQuery`
	`osid.financials.budgeting.BudgetQuerySession`
	`osid.financials.budgeting.BudgetSearchSession`
	`osid.financials.budgeting.BudgetSmartBusinessSession`
Description	This is the query for searching budgets. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
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` 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.
Return	`osid.financials.ActivityQuery`		the activity query
Errors	UNIMPLEMENTED		`supportsActivityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityQuery()` is `true`.
Method	clearActivityTerms
Description	Clears the activity 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		`foscalPeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFiscalPeriodIdTerms
Description	Clears the fiscal period `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodQuery
Description	Tests if a `FiscalPeriod` 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 any fiscal period.
Parameters	`boolean`	`match`	`true` to match budgets with any fiscal period, `false` to match budgets with no fiscal period
Compliance	`mandatory`		This method must be implemented.
Method	clearFiscalPeriodTerms
Description	Clears the fiscal period terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBudgetEntryId
Description	Sets the budget entry `Id` for this query.
Parameters	`osid.id.Id`	`budgetEntryId`	a budget entry `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`budgetEntryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBudgetEntryIdTerms
Description	Clears the budget entry `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntryQuery
Description	Tests if an `BudgetEntryQuery` is available.
Return	`boolean`		`true` if a budget entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntryQuery
Description	Gets the query for a budget entries. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.budgeting.BudgetEntryQuery`		the budget entry query
Errors	UNIMPLEMENTED		`supportsBudgetEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryQuery()` is `true`.
Method	matchAnyBudgetEntry
Description	Matches any related budget entries.
Parameters	`boolean`	`match`	`true` to match budgets with any budget entry, `false` to match budgets with no entries
Compliance	`mandatory`		This method must be implemented.
Method	clearBudgetEntryTerms
Description	Clears the budget entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match budgets 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.financials.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	getBudgetQueryRecord
Description	Gets the budget query record corresponding to the given `Budget` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`budgetRecordType`	a budget record type
Return	`osid.financials.budgeting.records.BudgetQueryRecord`		the budget query record
Errors	NULL_ARGUMENT		`budgetRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(budgetRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.