Interface FiscalPeriodQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

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 .

Method Summary

Modifier and Type	Method	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(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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchDisplayLabel

void matchDisplayLabel(String label,
 Type stringMatchType,
 boolean match)

Adds a display label for this query.

Parameters:

label - label string to match

stringMatchType - the string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - label not of stringMatchType

NullArgumentException - label or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyDisplayLabel

void matchAnyDisplayLabel(boolean match)

Matches a display label that has any value.

Parameters:

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.

clearDisplayLabelTerms

void clearDisplayLabelTerms()

Clears the display label terms.

Compliance:

mandatory - This method must be implemented.

matchFiscalYear

void matchFiscalYear(long from,
 long to,
 boolean match)

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

Parameters:

from - start of year range

to - end of year range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

Compliance:

mandatory - This method must be implemented.

matchAnyFiscalYear

void matchAnyFiscalYear(boolean match)

Matches a fiscal year that has any value.

Parameters:

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.

clearFiscalYearTerms

void clearFiscalYearTerms()

Clears the fiscal year terms.

Compliance:

mandatory - This method must be implemented.

matchStartDate

void matchStartDate(DateTime from,
 DateTime to,
 boolean match)

Matches a start date within the given date range inclusive.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyStartDate

void matchAnyStartDate(boolean match)

Matches a start date that has any value.

Parameters:

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.

clearStartDateTerms

void clearStartDateTerms()

Clears the start date terms.

Compliance:

mandatory - This method must be implemented.

matchEndDate

void matchEndDate(DateTime from,
 DateTime to,
 boolean match)

Matches an end date within the given date range inclusive.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyEndDate

void matchAnyEndDate(boolean match)

Matches an end date that has any value.

Parameters:

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.

clearEndDateTerms

void clearEndDateTerms()

Clears the end date terms.

Compliance:

mandatory - This method must be implemented.

matchDuration

void matchDuration(Duration from,
 Duration to,
 boolean match)

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

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

clearDurationTerms

void clearDurationTerms()

Clears the duration terms.

Compliance:

mandatory - This method must be implemented.

matchBudgetDeadline

void matchBudgetDeadline(DateTime from,
 DateTime to,
 boolean match)

Matches a budget deadline within the given date range inclusive.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyBudgetDeadline

void matchAnyBudgetDeadline(boolean match)

Matches a budget deadline that has any value.

Parameters:

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.

clearBudgetDeadlineTerms

void clearBudgetDeadlineTerms()

Clears the budget deadline terms.

Compliance:

mandatory - This method must be implemented.

matchPostingDeadline

void matchPostingDeadline(DateTime from,
 DateTime to,
 boolean match)

Matches a posting deadline within the given date range inclusive.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyPostingDeadline

void matchAnyPostingDeadline(boolean match)

Matches a posting deadline that has any value.

Parameters:

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.

clearPostingDeadlineTerms

void clearPostingDeadlineTerms()

Clears the posting deadline terms.

Compliance:

mandatory - This method must be implemented.

matchClosing

void matchClosing(DateTime from,
 DateTime to,
 boolean match)

Matches a closing date within the given date range inclusive.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyClosing

void matchAnyClosing(boolean match)

Matches a closing date that has any value.

Parameters:

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.

clearClosingTerms

void clearClosingTerms()

Clears the closing terms.

Compliance:

mandatory - This method must be implemented.

matchBusinessId

void matchBusinessId(Id businessId,
 boolean match)

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

Parameters:

businessId - the business Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - businessId is null

Compliance:

mandatory - This method must be implemented.

clearBusinessIdTerms

void clearBusinessIdTerms()

Clears the business Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBusinessQuery

boolean supportsBusinessQuery()

Tests if a BusinessQuery is available.

Returns:

true if a business query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBusinessQuery

BusinessQuery getBusinessQuery()

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

Returns:

the business query

Throws:

UnimplementedException - supportsBusinessQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsBusinessQuery()} is {@code true} .

clearBusinessTerms

void clearBusinessTerms()

Clears the business terms.

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodQueryRecord

FiscalPeriodQueryRecord getFiscalPeriodQueryRecord(Type fiscalPeriodRecordType)
                                            throws OperationFailedException

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

Parameters:

fiscalPeriodRecordType - a fiscal period record type

Returns:

the fiscal period query record

Throws:

NullArgumentException - fiscalPeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fiscalPeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.