OSID - osid.financials.FiscalPeriodQuery Service Interface Definition

Interface	osid.financials.FiscalPeriodQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.financials.BusinessQuery`
	`osid.financials.FiscalPeriodQuerySession`
	`osid.financials.FiscalPeriodSearchSession`
	`osid.financials.FiscalPeriodSmartBusinessSession`
	`osid.financials.SummaryQuery`
	`osid.financials.budgeting.BudgetQuery`
	`osid.financials.posting.PostQuery`
Description	This is the query for searching fiscal periods. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchDisplayLabel
Description	Adds a display label for this query.
Parameters	`string`	`label`	label string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`label` not of `stringMatchType`
	NULL_ARGUMENT		`label` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDisplayLabel
Description	Matches a display label that has any value.
Parameters	`boolean`	`match`	`true` to match fiscal periods with any display label, `false` to match fiscal periods with no display label
Compliance	`mandatory`		This method must be implemented.
Method	clearDisplayLabelTerms
Description	Clears the display label terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFiscalYear
Description	Adds a fiscal year for this query to match periods in the given fiscal years inclusive.
Parameters	`integer`	`from`	start of year range
	`integer`	`to`	end of year range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyFiscalYear
Description	Matches a fiscal year that has any value.
Parameters	`boolean`	`match`	`true` to match fiscal periods with any fiscal year, `false` to match fiscal periods with no fiscal year
Compliance	`mandatory`		This method must be implemented.
Method	clearFiscalYearTerms
Description	Clears the fiscal year terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStartDate
Description	Matches a start date within the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start of range
	`osid.calendaring.DateTime`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyStartDate
Description	Matches a start date that has any value.
Parameters	`boolean`	`match`	`true` to match fiscal periods with any start date, `false` to match fiscal periods with no start date
Compliance	`mandatory`		This method must be implemented.
Method	clearStartDateTerms
Description	Clears the start date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEndDate
Description	Matches an end date within the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start of range
	`osid.calendaring.DateTime`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyEndDate
Description	Matches an end date that has any value.
Parameters	`boolean`	`match`	`true` to match fiscal periods with any end date, `false` to match fiscal periods with no end date
Compliance	`mandatory`		This method must be implemented.
Method	clearEndDateTerms
Description	Clears the end date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDuration
Description	Matches a fiscal period duratione within the given date range inclusive.
Parameters	`osid.calendaring.Duration`	`from`	start of range
	`osid.calendaring.Duration`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDurationTerms
Description	Clears the duration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBudgetDeadline
Description	Matches a budget deadline within the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start of range
	`osid.calendaring.DateTime`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyBudgetDeadline
Description	Matches a budget deadline that has any value.
Parameters	`boolean`	`match`	`true` to match fiscal periods with any budget deadline, `false` to match fiscal periods with no budget deadline
Compliance	`mandatory`		This method must be implemented.
Method	clearBudgetDeadlineTerms
Description	Clears the budget deadline terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPostingDeadline
Description	Matches a posting deadline within the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start of range
	`osid.calendaring.DateTime`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPostingDeadline
Description	Matches a posting deadline that has any value.
Parameters	`boolean`	`match`	`true` to match fiscal periods with any posting deadline, `false` to match fiscal periods with no posting deadline
Compliance	`mandatory`		This method must be implemented.
Method	clearPostingDeadlineTerms
Description	Clears the posting deadline terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchClosing
Description	Matches a closing date within the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start of range
	`osid.calendaring.DateTime`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyClosing
Description	Matches a closing date that has any value.
Parameters	`boolean`	`match`	`true` to match fiscal periods with any closing date, `false` to match fiscal periods with no closing date
Compliance	`mandatory`		This method must be implemented.
Method	clearClosingTerms
Description	Clears the closing terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match fiscal periods 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	getFiscalPeriodQueryRecord
Description	Gets the fiscal period query record corresponding to the given `FiscalPeriod` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`fiscalPeriodRecordType`	a fiscal period record type
Return	`osid.financials.records.FiscalPeriodQueryRecord`		the fiscal period query record
Errors	NULL_ARGUMENT		`fiscalPeriodRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(fiscalPeriodRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.