Interface EdgeEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface EdgeEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
EdgeEnablerQueryInspector	getEdgeEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
EdgeEnablerList	getEdgeEnablers()	Gets the EdgeEnablerList resulting from a search.
EdgeEnablerSearchResultsRecord	getEdgeEnablerSearchResultsRecord(Type edgeEnablerSearchRecordType)	Gets the edge enabler search results record corresponding to the given edge enabler search record Type .This method must be 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

getEdgeEnablers

EdgeEnablerList getEdgeEnablers()

Gets the EdgeEnablerList resulting from a search.

Returns:

the edge enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerQueryInspector

EdgeEnablerQueryInspector getEdgeEnablerQueryInspector()

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

Returns:

the edge enabler query inspector

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerSearchResultsRecord

EdgeEnablerSearchResultsRecord getEdgeEnablerSearchResultsRecord(Type edgeEnablerSearchRecordType)
                                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

edgeEnablerSearchRecordType - an edge enabler search record type

Returns:

the edge enabler search results record

Throws:

NullArgumentException - edgeEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(edgeEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.