Interface GraphSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface GraphSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
GraphQueryInspector	getGraphQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
GraphList	getGraphs()	Gets the graph list resulting from a search.
GraphSearchResultsRecord	getGraphSearchResultsRecord(Type graphSearchRecordType)	Gets the graph search results record corresponding to the given graph 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

getGraphs

GraphList getGraphs()

Gets the graph list resulting from a search.

Returns:

the graph list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getGraphQueryInspector

GraphQueryInspector getGraphQueryInspector()

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

Returns:

the graph query inspector

Compliance:

mandatory - This method must be implemented.

getGraphSearchResultsRecord

GraphSearchResultsRecord getGraphSearchResultsRecord(Type graphSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

graphSearchRecordType - a graph search record type

Returns:

the graph search results record

Throws:

NullArgumentException - graphSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(graphSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.