org.osid.financials.budgeting

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

Methods

Modifier and Type	Method and 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.
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 org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

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

Method Detail

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 supportsActivityQuery() is 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 supportsFiscalPeriodQuery() is 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 supportsBudgetEntryQuery() is 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 supportsBusinessQuery() is 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.