Interface BudgetEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BudgetEntrySearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BudgetEntryList	getBudgetEntries()	Gets the budget entry list resulting from a search.
BudgetEntryQueryInspector	getBudgetEntryQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BudgetEntrySearchResultsRecord	getBudgetEntrySearchResultsRecord(Type budgetEntrySearchRecordType)	Gets the budget entry search results record corresponding to the given budget entry 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

getBudgetEntries

BudgetEntryList getBudgetEntries()

Gets the budget entry list resulting from a search.

Returns:

the budget entry list

Throws:

IllegalStateException - the budget entry list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBudgetEntryQueryInspector

BudgetEntryQueryInspector getBudgetEntryQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getBudgetEntrySearchResultsRecord

BudgetEntrySearchResultsRecord getBudgetEntrySearchResultsRecord(Type budgetEntrySearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

budgetEntrySearchRecordType - a budget entry search record type

Returns:

the budget entry search results record

Throws:

NullArgumentException - budgetEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.