org.osid.billing

Interface EntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface EntrySearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
EntryList	getEntries() Gets the entry list resulting from a search.
EntryQueryInspector	getEntryQueryInspector() Gets the inspector for the query to examine the terms used in the search.
EntrySearchResultsRecord	getEntrySearchResultsRecord(Type entrySearchRecordType) Gets the entry search results record corresponding to the given 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

getEntries

EntryList getEntries()

Gets the entry list resulting from a search.

Returns:

the entry list

Throws:

IllegalStateException - the entry list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getEntryQueryInspector

EntryQueryInspector getEntryQueryInspector()

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.

getEntrySearchResultsRecord

EntrySearchResultsRecord getEntrySearchResultsRecord(Type entrySearchRecordType)
                                                     throws OperationFailedException

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

Parameters:

entrySearchRecordType - a entry search record type

Returns:

the entry search interface

Throws:

NullArgumentException - entrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.