Interface DeedSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DeedSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
DeedQueryInspector	getDeedQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
DeedList	getDeeds()	Gets the deed list resulting from a search.
DeedSearchResultsRecord	getDeedSearchResultsRecord(Type deedSearchRecordType)	Gets the deed search results record corresponding to the given deed 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

getDeeds

DeedList getDeeds()

Gets the deed list resulting from a search.

Returns:

the deed list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getDeedQueryInspector

DeedQueryInspector getDeedQueryInspector()

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.

getDeedSearchResultsRecord

DeedSearchResultsRecord getDeedSearchResultsRecord(Type deedSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

deedSearchRecordType - a deed search record type

Returns:

the deed search results record

Throws:

NullArgumentException - deedSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deedSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.