Interface BudgetSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BudgetSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getBudgets

BudgetList getBudgets()

Gets the budget list resulting from a search.

Returns:

the budget list

Throws:

IllegalStateException - the budget list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBudgetQueryInspector

BudgetQueryInspector getBudgetQueryInspector()

Gets the inspector for the query to examine the periods used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getBudgetSearchResultsRecord

BudgetSearchResultsRecord getBudgetSearchResultsRecord(Type budgetSearchRecordType)
                                                throws OperationFailedException

Gets the budget search results record corresponding to the given budget search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

budgetSearchRecordType - a budget search record type

Returns:

the budget search results record

Throws:

NullArgumentException - budgetSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.