org.osid.financials.posting

Interface PostEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PostEntrySearch
extends OsidSearch

The search interface for governing post entry searches.

Method Summary

Methods

Modifier and Type	Method and Description
PostEntrySearchRecord	getPostEntrySearchRecord(Type postEntrySearchRecordType) Gets the post entry search record corresponding to the given post entry search record Type.
void	orderPostEntryResults(PostEntrySearchOrder postEntrySearchOrder) Specify an ordering to the search results.
void	searchAmongPostEntries(IdList postEntryIds) Execute this search among the given list of post entries.

Methods inherited from interface org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

searchAmongPostEntries

void searchAmongPostEntries(IdList postEntryIds)

Execute this search among the given list of post entries.

Parameters:

postEntryIds - list of entries

Throws:

NullArgumentException - postEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderPostEntryResults

void orderPostEntryResults(PostEntrySearchOrder postEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

postEntrySearchOrder - post entry search order

Throws:

NullArgumentException - postEntrySearchOrder is null

UnsupportedException - postEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPostEntrySearchRecord

PostEntrySearchRecord getPostEntrySearchRecord(Type postEntrySearchRecordType)
                                               throws OperationFailedException

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

Parameters:

postEntrySearchRecordType - a post entry search record type

Returns:

the post entry search record

Throws:

NullArgumentException - postEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.