Interface WorkSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface WorkSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
WorkQueryInspector	getWorkQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
WorkList	getWorks()	Gets the work list resulting from a search.
WorkSearchResultsRecord	getWorkSearchResultsRecord(Type workSearchRecordType)	Gets the work search results record corresponding to the given work 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

getWorks

WorkList getWorks()

Gets the work list resulting from a search.

Returns:

the work list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getWorkQueryInspector

WorkQueryInspector getWorkQueryInspector()

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

Returns:

the work query inspector

Compliance:

mandatory - This method must be implemented.

getWorkSearchResultsRecord

WorkSearchResultsRecord getWorkSearchResultsRecord(Type workSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

workSearchRecordType - a work search record type

Returns:

the work search results record

Throws:

NullArgumentException - workSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.