Interface PressSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PressSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PressList	getPresses()	Gets the press list resulting from a search.
PressQueryInspector	getPressQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
PressSearchResultsRecord	getPressSearchResultsRecord(Type pressSearchRecordType)	Gets the press search results record corresponding to the given press search record Type .This method is used to retrieve an object implementing the requested record.

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

getPresses

PressList getPresses()

Gets the press list resulting from a search.

Returns:

the press list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getPressQueryInspector

PressQueryInspector getPressQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the press query inspector

Compliance:

mandatory - This method must be implemented.

getPressSearchResultsRecord

PressSearchResultsRecord getPressSearchResultsRecord(Type pressSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

pressSearchRecordType - an press search record type

Returns:

the press search results record

Throws:

NullArgumentException - pressSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pressSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.