Interface BudgetEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BudgetEntrySearch
extends OsidSearch

The search interface for governing budget entry searches.

Method Summary

Modifier and Type	Method	Description
BudgetEntrySearchRecord	getBudgetEntrySearchRecord(Type budgetEntrySearchRecordType)	Gets the budget entry search record corresponding to the given budget entry search record Type .This method is used to retrieve an object implementing the requested record.
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.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongBudgetEntries

void searchAmongBudgetEntries(IdList budgetEntryIds)

Execute this search among the given list of budget entries.

Parameters:

budgetEntryIds - list of entries

Throws:

NullArgumentException - budgetEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderBudgetEntryResults

void orderBudgetEntryResults(BudgetEntrySearchOrder budgetEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

budgetEntrySearchOrder - budget entry search order

Throws:

NullArgumentException - budgetEntrySearchOrder is null

UnsupportedException - budgetEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBudgetEntrySearchRecord

BudgetEntrySearchRecord getBudgetEntrySearchRecord(Type budgetEntrySearchRecordType)
                                            throws OperationFailedException

Gets the budget entry search 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 record

Throws:

NullArgumentException - budgetEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.