Interface BudgetQuery

All Superinterfaces:

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

public interface BudgetQuery
extends OsidRelationshipQuery

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 Summary

Modifier and Type	Method	Description
void	clearActivityIdTerms()	Clears the activity Id terms.
void	clearActivityTerms()	Clears the activity terms.
void	clearBudgetEntryIdTerms()	Clears the budget entry Id terms.
void	clearBudgetEntryTerms()	Clears the budget entry terms.
void	clearBusinessIdTerms()	Clears the business Id terms.
void	clearBusinessTerms()	Clears the business terms.
void	clearFiscalPeriodIdTerms()	Clears the fiscal period Id terms.
void	clearFiscalPeriodTerms()	Clears the fiscal period terms.
ActivityQuery	getActivityQuery()	Gets the query for an activity.
BudgetEntryQuery	getBudgetEntryQuery()	Gets the query for a budget entries.
BudgetQueryRecord	getBudgetQueryRecord(Type budgetRecordType)	Gets the budget query record corresponding to the given Budget record Type .Multiple record retrievals produce a nested OR term.
BusinessQuery	getBusinessQuery()	Gets the query for a business.
FiscalPeriodQuery	getFiscalPeriodQuery()	Gets the query for a fiscal period.
void	matchActivityId(Id activityId, boolean match)	Sets the activity Id for this query.
void	matchAnyBudgetEntry(boolean match)	Matches any related budget entries.
void	matchAnyFiscalPeriod(boolean match)	Matches any fiscal period.
void	matchBudgetEntryId(Id budgetEntryId, boolean match)	Sets the budget entry Id for this query.
void	matchBusinessId(Id businessId, boolean match)	Sets the business Id for this query to match budgets assigned to businesses.
void	matchFiscalPeriodId(Id fiscalPeriodId, boolean match)	Sets the fiscal period Id for this query.
boolean	supportsActivityQuery()	Tests if an ActivityQuery is available.
boolean	supportsBudgetEntryQuery()	Tests if an BudgetEntryQuery is available.
boolean	supportsBusinessQuery()	Tests if a BusinessQuery is available.
boolean	supportsFiscalPeriodQuery()	Tests if a FiscalPeriod 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.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

matchActivityId

void matchActivityId(Id activityId,
 boolean match)

Sets the activity Id for this query.

Parameters:

activityId - an activity Id

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

Throws:

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActivityIdTerms

void clearActivityIdTerms()

Clears the activity Id terms.

Compliance:

mandatory - This method must be implemented.

supportsActivityQuery

boolean supportsActivityQuery()

Tests if an ActivityQuery is available.

Returns:

true if an activity query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityQuery

ActivityQuery getActivityQuery()

Gets the query for an activity.

Returns:

the activity query

Throws:

UnimplementedException - supportsActivityQuery() is false

Compliance:

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

clearActivityTerms

void clearActivityTerms()

Clears the activity terms.

Compliance:

mandatory - This method must be implemented.

matchFiscalPeriodId

void matchFiscalPeriodId(Id fiscalPeriodId,
 boolean match)

Sets the fiscal period Id for this query.

Parameters:

fiscalPeriodId - a fiscal period Id

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

Throws:

NullArgumentException - foscalPeriodId is null

Compliance:

mandatory - This method must be implemented.

clearFiscalPeriodIdTerms

void clearFiscalPeriodIdTerms()

Clears the fiscal period Id terms.

Compliance:

mandatory - This method must be implemented.

supportsFiscalPeriodQuery

boolean supportsFiscalPeriodQuery()

Tests if a FiscalPeriod is available.

Returns:

true if a fiscal period query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodQuery

FiscalPeriodQuery getFiscalPeriodQuery()

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

Returns:

the fiscal period query

Throws:

UnimplementedException - supportsFiscalPeriodQuery() is false

Compliance:

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

matchAnyFiscalPeriod

void matchAnyFiscalPeriod(boolean match)

Matches any fiscal period.

Parameters:

match - true to match budgets with any fiscal period, false to match budgets with no fiscal period

Compliance:

mandatory - This method must be implemented.

clearFiscalPeriodTerms

void clearFiscalPeriodTerms()

Clears the fiscal period terms.

Compliance:

mandatory - This method must be implemented.

matchBudgetEntryId

void matchBudgetEntryId(Id budgetEntryId,
 boolean match)

Sets the budget entry Id for this query.

Parameters:

budgetEntryId - a budget entry Id

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

Throws:

NullArgumentException - budgetEntryId is null

Compliance:

mandatory - This method must be implemented.

clearBudgetEntryIdTerms

void clearBudgetEntryIdTerms()

Clears the budget entry Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBudgetEntryQuery

boolean supportsBudgetEntryQuery()

Tests if an BudgetEntryQuery is available.

Returns:

true if a budget entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBudgetEntryQuery

BudgetEntryQuery getBudgetEntryQuery()

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

Returns:

the budget entry query

Throws:

UnimplementedException - supportsBudgetEntryQuery() is false

Compliance:

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

matchAnyBudgetEntry

void matchAnyBudgetEntry(boolean match)

Matches any related budget entries.

Parameters:

match - true to match budgets with any budget entry, false to match budgets with no entries

Compliance:

mandatory - This method must be implemented.

clearBudgetEntryTerms

void clearBudgetEntryTerms()

Clears the budget entry terms.

Compliance:

mandatory - This method must be implemented.

matchBusinessId

void matchBusinessId(Id businessId,
 boolean match)

Sets the business Id for this query to match budgets 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.

getBudgetQueryRecord

BudgetQueryRecord getBudgetQueryRecord(Type budgetRecordType)
                                throws OperationFailedException

Gets the budget query record corresponding to the given Budget record Type .Multiple record retrievals produce a nested OR term.

Parameters:

budgetRecordType - a budget record type

Returns:

the budget query record

Throws:

NullArgumentException - budgetRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetRecordType) is false

Compliance:

mandatory - This method must be implemented.