Interface EdgeSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface EdgeSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
EdgeQueryInspector	getEdgeQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
EdgeList	getEdges()	Gets the edge list resulting from a search.
EdgeSearchResultsRecord	getEdgeSearchResultsRecord(Type edgeSearchRecordType)	Gets the edge search results record corresponding to the given edge 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

getEdges

EdgeList getEdges()

Gets the edge list resulting from a search.

Returns:

the edge list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getEdgeQueryInspector

EdgeQueryInspector getEdgeQueryInspector()

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

Returns:

the edge query inspector

Compliance:

mandatory - This method must be implemented.

getEdgeSearchResultsRecord

EdgeSearchResultsRecord getEdgeSearchResultsRecord(Type edgeSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

edgeSearchRecordType - an edge search record type

Returns:

the edge search results record

Throws:

NullArgumentException - edgeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(edgeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.