public interface FiscalPeriodQuery extends OsidObjectQuery
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.
Modifier and Type | Method and Description |
---|---|
void |
clearBudgetDeadlineTerms()
Clears the budget deadline terms.
|
void |
clearBusinessIdTerms()
Clears the business
Id terms. |
void |
clearBusinessTerms()
Clears the business terms.
|
void |
clearClosingTerms()
Clears the closing terms.
|
void |
clearDisplayLabelTerms()
Clears the display label terms.
|
void |
clearDurationTerms()
Clears the duration terms.
|
void |
clearEndDateTerms()
Clears the end date terms.
|
void |
clearFiscalYearTerms()
Clears the fiscal year terms.
|
void |
clearPostingDeadlineTerms()
Clears the posting deadline terms.
|
void |
clearStartDateTerms()
Clears the start date terms.
|
BusinessQuery |
getBusinessQuery()
Gets the query for a business.
|
FiscalPeriodQueryRecord |
getFiscalPeriodQueryRecord(Type fiscalPeriodRecordType)
Gets the fiscal period query record corresponding to the given
FiscalPeriod record Type. |
void |
matchAnyBudgetDeadline(boolean match)
Matches a budget deadline that has any value.
|
void |
matchAnyClosing(boolean match)
Matches a closing date that has any value.
|
void |
matchAnyDisplayLabel(boolean match)
Matches a display label that has any value.
|
void |
matchAnyEndDate(boolean match)
Matches an end date that has any value.
|
void |
matchAnyFiscalYear(boolean match)
Matches a fiscal year that has any value.
|
void |
matchAnyPostingDeadline(boolean match)
Matches a posting deadline that has any value.
|
void |
matchAnyStartDate(boolean match)
Matches a start date that has any value.
|
void |
matchBudgetDeadline(DateTime from,
DateTime to,
boolean match)
Matches a budget deadline within the given date range inclusive.
|
void |
matchBusinessId(Id businessId,
boolean match)
Sets the business
Id for this query to match fiscal
periods assigned to businesses. |
void |
matchClosing(DateTime from,
DateTime to,
boolean match)
Matches a closing date within the given date range inclusive.
|
void |
matchDisplayLabel(java.lang.String label,
Type stringMatchType,
boolean match)
Adds a display label for this query.
|
void |
matchDuration(Duration from,
Duration to,
boolean match)
Matches a fiscal period duratione within the given date range
inclusive.
|
void |
matchEndDate(DateTime from,
DateTime to,
boolean match)
Matches an end date within the given date range inclusive.
|
void |
matchFiscalYear(long from,
long to,
boolean match)
Adds a fiscal year for this query to match periods in the given fiscal
years inclusive.
|
void |
matchPostingDeadline(DateTime from,
DateTime to,
boolean match)
Matches a posting deadline within the given date range inclusive.
|
void |
matchStartDate(DateTime from,
DateTime to,
boolean match)
Matches a start date within the given date range inclusive.
|
boolean |
supportsBusinessQuery()
Tests if a
BusinessQuery is available. |
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchDisplayLabel(java.lang.String label, Type stringMatchType, boolean match)
label
- label string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- label
not of
stringMatchType
NullArgumentException
- label
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyDisplayLabel(boolean match)
match
- true
to match fiscal periods with any
display label, false
to match fiscal periods
with no display labelmandatory
- This method must be implemented. void clearDisplayLabelTerms()
mandatory
- This method must be implemented. void matchFiscalYear(long from, long to, boolean match)
from
- start of year rangeto
- end of year rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
mandatory
- This method must be implemented. void matchAnyFiscalYear(boolean match)
match
- true
to match fiscal periods with any
fiscal year, false
to match fiscal periods with
no fiscal yearmandatory
- This method must be implemented. void clearFiscalYearTerms()
mandatory
- This method must be implemented. void matchStartDate(DateTime from, DateTime to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyStartDate(boolean match)
match
- true
to match fiscal periods with any
start date, false
to match fiscal periods with
no start datemandatory
- This method must be implemented. void clearStartDateTerms()
mandatory
- This method must be implemented. void matchEndDate(DateTime from, DateTime to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyEndDate(boolean match)
match
- true
to match fiscal periods with any end
date, false
to match fiscal periods with no end
datemandatory
- This method must be implemented. void clearEndDateTerms()
mandatory
- This method must be implemented. void matchDuration(Duration from, Duration to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void clearDurationTerms()
mandatory
- This method must be implemented. void matchBudgetDeadline(DateTime from, DateTime to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyBudgetDeadline(boolean match)
match
- true
to match fiscal periods with any
budget deadline, false
to match fiscal periods
with no budget deadlinemandatory
- This method must be implemented. void clearBudgetDeadlineTerms()
mandatory
- This method must be implemented. void matchPostingDeadline(DateTime from, DateTime to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyPostingDeadline(boolean match)
match
- true
to match fiscal periods with any
posting deadline, false
to match fiscal periods
with no posting deadlinemandatory
- This method must be implemented. void clearPostingDeadlineTerms()
mandatory
- This method must be implemented. void matchClosing(DateTime from, DateTime to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyClosing(boolean match)
match
- true
to match fiscal periods with any
closing date, false
to match fiscal periods
with no closing datemandatory
- This method must be implemented. void clearClosingTerms()
mandatory
- This method must be implemented. void matchBusinessId(Id businessId, boolean match)
Id
for this query to match fiscal
periods assigned to businesses.businessId
- the business Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- businessId
is
null
mandatory
- This method must be implemented. void clearBusinessIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBusinessQuery()
BusinessQuery
is available. true
if a business query is available,
false
otherwisemandatory
- This method must be implemented. BusinessQuery getBusinessQuery()
OR
term.UnimplementedException
- supportsBusinessQuery()
is false
optional
- This method must be implemented if
supportsBusinessQuery()
is true.
void clearBusinessTerms()
mandatory
- This method must be implemented. FiscalPeriodQueryRecord getFiscalPeriodQueryRecord(Type fiscalPeriodRecordType) throws OperationFailedException
FiscalPeriod
record Type.
Multiple record
retrievals produce a nested OR
term.fiscalPeriodRecordType
- a fiscal period record typeNullArgumentException
- fiscalPeriodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(fiscalPeriodRecordType)
is false
mandatory
- This method must be implemented.