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.
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. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchActivityId(Id activityId, boolean match)
Id
for this query.activityId
- an activity Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- activityId
is
null
mandatory
- This method must be implemented. void clearActivityIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsActivityQuery()
ActivityQuery
is available. true
if an activity query is available,
false
otherwisemandatory
- This method must be implemented. ActivityQuery getActivityQuery()
UnimplementedException
- supportsActivityQuery()
is false
optional
- This method must be implemented if
supportsActivityQuery()
is true.
void clearActivityTerms()
mandatory
- This method must be implemented. void matchFiscalPeriodId(Id fiscalPeriodId, boolean match)
Id
for this query.fiscalPeriodId
- a fiscal period Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- foscalPeriodId
is null
mandatory
- This method must be implemented. void clearFiscalPeriodIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsFiscalPeriodQuery()
FiscalPeriod
is available. true
if a fiscal period query is available,
false
otherwisemandatory
- This method must be implemented. FiscalPeriodQuery getFiscalPeriodQuery()
OR
term.UnimplementedException
-
supportsFiscalPeriodQuery()
is false
optional
- This method must be implemented if
supportsFiscalPeriodQuery()
is true.
void matchAnyFiscalPeriod(boolean match)
match
- true
to match budgets with any fiscal
period, false
to match budgets with no fiscal
periodmandatory
- This method must be implemented. void clearFiscalPeriodTerms()
mandatory
- This method must be implemented. void matchBudgetEntryId(Id budgetEntryId, boolean match)
Id
for this query.budgetEntryId
- a budget entry Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- budgetEntryId
is
null
mandatory
- This method must be implemented. void clearBudgetEntryIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBudgetEntryQuery()
BudgetEntryQuery
is available. true
if a budget entry query is available,
false
otherwisemandatory
- This method must be implemented. BudgetEntryQuery getBudgetEntryQuery()
OR
term.UnimplementedException
-
supportsBudgetEntryQuery()
is false
optional
- This method must be implemented if
supportsBudgetEntryQuery()
is true.
void matchAnyBudgetEntry(boolean match)
match
- true
to match budgets with any budget
entry, false
to match budgets with no entriesmandatory
- This method must be implemented. void clearBudgetEntryTerms()
mandatory
- This method must be implemented. void matchBusinessId(Id businessId, boolean match)
Id
for this query to match budgets
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. BudgetQueryRecord getBudgetQueryRecord(Type budgetRecordType) throws OperationFailedException
Budget
record Type.
Multiple record retrievals produce
a nested OR
term.budgetRecordType
- a budget record typeNullArgumentException
- budgetRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(budgetRecordType)
is false
mandatory
- This method must be implemented.