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

Modifier and Type	Method	Description
EntryList	getEntries()	Gets the entry list resulting from the 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 .This method is used to retrieve an object implementing the requested record interface.

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

getEntries

EntryList getEntries()

Gets the entry list resulting from the search.

Returns:

the entry list

Throws:

IllegalStateException - list already 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 entry 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 interface.

Parameters:

entrySearchRecordType - an entry search record type

Returns:

the entry search results record

Throws:

NullArgumentException - entrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.