Interface OublietteSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface OublietteSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
OublietteQueryInspector	getOublietteQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
OublietteList	getOubliettes()	Gets the oubliette list resulting from a search.
OublietteSearchResultsRecord	getOublietteSearchResultsRecord(Type oublietteSearchRecordType)	Gets the oubliette search results record corresponding to the given oubliette 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

getOubliettes

OublietteList getOubliettes()

Gets the oubliette list resulting from a search.

Returns:

the oubliette list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getOublietteQueryInspector

OublietteQueryInspector getOublietteQueryInspector()

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

Returns:

the oubliette query inspector

Compliance:

mandatory - This method must be implemented.

getOublietteSearchResultsRecord

OublietteSearchResultsRecord getOublietteSearchResultsRecord(Type oublietteSearchRecordType)
                                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

oublietteSearchRecordType - an oubliette search record type

Returns:

the oubliette search results record

Throws:

NullArgumentException - oublietteSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(oublietteSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.