Interface PublisherSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PublisherSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PublisherQueryInspector	getPublisherQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
PublisherList	getPublishers()	Gets the publisher list resulting from a search.
PublisherSearchResultsRecord	getPublisherSearchResultsRecord(Type publisherSearchRecordType)	Gets the publisher search results record corresponding to the given publisher search record Type.

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

getPublishers

PublisherList getPublishers()

Gets the publisher list resulting from a search.

Returns:

the publisher list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPublisherQueryInspector

PublisherQueryInspector getPublisherQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getPublisherSearchResultsRecord

PublisherSearchResultsRecord getPublisherSearchResultsRecord(Type publisherSearchRecordType)
                                                      throws OperationFailedException

Gets the publisher search results record corresponding to the given publisher search record Type. This method must be used to retrieve an object implementing the requested record.

Parameters:

publisherSearchRecordType - a publisher search record type

Returns:

the publisher search results record

Throws:

NullArgumentException - publisherSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(publisherSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.