public interface BudgetSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
BudgetQueryInspector |
getBudgetQueryInspector()
Gets the inspector for the query to examine the periods used in the
search.
|
BudgetList |
getBudgets()
Gets the budget list resulting from a search.
|
BudgetSearchResultsRecord |
getBudgetSearchResultsRecord(Type budgetSearchRecordType)
Gets the budget search results record corresponding to the given
budget search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
BudgetList getBudgets()
IllegalStateException
- the budget list has already
been retrievedmandatory
- This method must be implemented. BudgetQueryInspector getBudgetQueryInspector()
mandatory
- This method must be implemented. BudgetSearchResultsRecord getBudgetSearchResultsRecord(Type budgetSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.budgetSearchRecordType
- a budget search record typeNullArgumentException
- budgetSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(budgetSearchRecordType)
is false
mandatory
- This method must be implemented.