org.osid.financials.posting

Interface PostEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PostEntrySearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
PostEntryList	getPostEntries() Gets the post entry list resulting from a search.
PostEntryQueryInspector	getPostEntryQueryInspector() Gets the inspector for the query to examine the terms used in the search.
PostEntrySearchResultsRecord	getPostEntrySearchResultsRecord(Type postEntrySearchRecordType) Gets the post entry search results record corresponding to the given post entry search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getPostEntries

PostEntryList getPostEntries()

Gets the post entry list resulting from a search.

Returns:

the post entry list

Throws:

IllegalStateException - the post entry list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPostEntryQueryInspector

PostEntryQueryInspector getPostEntryQueryInspector()

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.

getPostEntrySearchResultsRecord

PostEntrySearchResultsRecord getPostEntrySearchResultsRecord(Type postEntrySearchRecordType)
                                                             throws OperationFailedException

Gets the post entry search results 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 interface

Throws:

NullArgumentException - postEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.