OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.FiscalPeriodQuery
Implementsosid.OsidObjectQuery
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.

MethodmatchDisplayLabel
Description

Adds a display label for this query.

Parametersstringlabellabel string to match
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT label not of stringMatchType
NULL_ARGUMENT label or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyDisplayLabel
Description

Matches a display label that has any value.

Parametersbooleanmatch true to match fiscal periods with any display label, false to match fiscal periods with no display label
CompliancemandatoryThis method must be implemented.
MethodclearDisplayLabelTerms
Description

Clears the display label terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFiscalYear
Description

Adds a fiscal year for this query to match periods in the given fiscal years inclusive.

Parametersintegerfromstart of year range
integertoend of year range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
CompliancemandatoryThis method must be implemented.
MethodmatchAnyFiscalYear
Description

Matches a fiscal year that has any value.

Parametersbooleanmatch true to match fiscal periods with any fiscal year, false to match fiscal periods with no fiscal year
CompliancemandatoryThis method must be implemented.
MethodclearFiscalYearTerms
Description

Clears the fiscal year terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStartDate
Description

Matches a start date within the given date range inclusive.

Parametersosid.calendaring.DateTimefromstart of range
osid.calendaring.DateTimetoend of range
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyStartDate
Description

Matches a start date that has any value.

Parametersbooleanmatch true to match fiscal periods with any start date, false to match fiscal periods with no start date
CompliancemandatoryThis method must be implemented.
MethodclearStartDateTerms
Description

Clears the start date terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEndDate
Description

Matches an end date within the given date range inclusive.

Parametersosid.calendaring.DateTimefromstart of range
osid.calendaring.DateTimetoend of range
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyEndDate
Description

Matches an end date that has any value.

Parametersbooleanmatch true to match fiscal periods with any end date, false to match fiscal periods with no end date
CompliancemandatoryThis method must be implemented.
MethodclearEndDateTerms
Description

Clears the end date terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDuration
Description

Matches a fiscal period duratione within the given date range inclusive.

Parametersosid.calendaring.Durationfromstart of range
osid.calendaring.Durationtoend of range
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodclearDurationTerms
Description

Clears the duration terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBudgetDeadline
Description

Matches a budget deadline within the given date range inclusive.

Parametersosid.calendaring.DateTimefromstart of range
osid.calendaring.DateTimetoend of range
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyBudgetDeadline
Description

Matches a budget deadline that has any value.

Parametersbooleanmatch true to match fiscal periods with any budget deadline, false to match fiscal periods with no budget deadline
CompliancemandatoryThis method must be implemented.
MethodclearBudgetDeadlineTerms
Description

Clears the budget deadline terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPostingDeadline
Description

Matches a posting deadline within the given date range inclusive.

Parametersosid.calendaring.DateTimefromstart of range
osid.calendaring.DateTimetoend of range
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyPostingDeadline
Description

Matches a posting deadline that has any value.

Parametersbooleanmatch true to match fiscal periods with any posting deadline, false to match fiscal periods with no posting deadline
CompliancemandatoryThis method must be implemented.
MethodclearPostingDeadlineTerms
Description

Clears the posting deadline terms.

CompliancemandatoryThis method must be implemented.
MethodmatchClosing
Description

Matches a closing date within the given date range inclusive.

Parametersosid.calendaring.DateTimefromstart of range
osid.calendaring.DateTimetoend of range
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyClosing
Description

Matches a closing date that has any value.

Parametersbooleanmatch true to match fiscal periods with any closing date, false to match fiscal periods with no closing date
CompliancemandatoryThis method must be implemented.
MethodclearClosingTerms
Description

Clears the closing terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBusinessId
Description

Sets the business Id for this query to match fiscal periods assigned to businesses.

Parametersosid.id.IdbusinessIdthe business Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT businessId is null
CompliancemandatoryThis method must be implemented.
MethodclearBusinessIdTerms
Description

Clears the business Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessQuery
Description

Tests if a BusinessQuery is available.

Returnboolean true if a business query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBusinessQuery
Description

Gets the query for a business. Multiple retrievals produce a nested OR term.

Returnosid.financials.BusinessQuerythe business query
ErrorsUNIMPLEMENTED supportsBusinessQuery() is false
ComplianceoptionalThis method must be implemented if supportsBusinessQuery() is true.
MethodclearBusinessTerms
Description

Clears the business terms.

CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodQueryRecord
Description

Gets the fiscal period query record corresponding to the given FiscalPeriod record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypefiscalPeriodRecordTypea fiscal period record type
Returnosid.financials.records.FiscalPeriodQueryRecordthe fiscal period query record
ErrorsNULL_ARGUMENT fiscalPeriodRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(fiscalPeriodRecordType) is false
CompliancemandatoryThis method must be implemented.