Interface EndpointSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface EndpointSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
EndpointQueryInspector	getEndpointQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
EndpointList	getEndpoints()	Gets the endpoint list resulting from the search.
EndpointSearchResultsRecord	getEndpointSearchResultsRecord(Type endpointSearchRecordType)	Gets the endpoint search results record corresponding to the given endpoint 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

getEndpoints

EndpointList getEndpoints()

Gets the endpoint list resulting from the search.

Returns:

the endpoint list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getEndpointQueryInspector

EndpointQueryInspector getEndpointQueryInspector()

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

Returns:

the endpoint query inspector

Compliance:

mandatory - This method must be implemented.

getEndpointSearchResultsRecord

EndpointSearchResultsRecord getEndpointSearchResultsRecord(Type endpointSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

endpointSearchRecordType - a endpoint search record type

Returns:

the endpoint search results record

Throws:

NullArgumentException - endpointSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(endpointSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.