public interface BudgetEntrySearch extends OsidSearch
The search interface for governing budget entry searches.
Modifier and Type | Method and Description |
---|---|
BudgetEntrySearchRecord |
getBudgetEntrySearchRecord(Type budgetEntrySearchRecordType)
Gets the budget entry search record corresponding to the given budget
entry search record
Type. |
void |
orderBudgetEntryResults(BudgetEntrySearchOrder budgetEntrySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongBudgetEntries(IdList budgetEntryIds)
Execute this search among the given list of budget entries.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBudgetEntries(IdList budgetEntryIds)
budgetEntryIds
- list of entriesNullArgumentException
- budgetEntryIds
is null
mandatory
- This method must be implemented. void orderBudgetEntryResults(BudgetEntrySearchOrder budgetEntrySearchOrder)
budgetEntrySearchOrder
- budget entry search orderNullArgumentException
- budgetEntrySearchOrder
is null
UnsupportedException
- budgetEntrySearchOrder
is not of this servicemandatory
- This method must be implemented. BudgetEntrySearchRecord getBudgetEntrySearchRecord(Type budgetEntrySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.budgetEntrySearchRecordType
- a budget entry search record typeNullArgumentException
-
budgetEntrySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(budgetEntrySearchRecordType)
is
false
mandatory
- This method must be implemented.