Interface DocetSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DocetSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
DocetQueryInspector	getDocetQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
DocetList	getDocets()	Gets the docet list resulting from a search.
DocetSearchResultsRecord	getDocetSearchResultsRecord(Type docetSearchRecordType)	Gets the docet search results record corresponding to the given docet 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

getDocets

DocetList getDocets()

Gets the docet list resulting from a search.

Returns:

the docet list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getDocetQueryInspector

DocetQueryInspector getDocetQueryInspector()

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.

getDocetSearchResultsRecord

DocetSearchResultsRecord getDocetSearchResultsRecord(Type docetSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

docetSearchRecordType - a docet search record type

Returns:

the docet search results record

Throws:

NullArgumentException - DocetSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(docetSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.