Interface RelevancyEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RelevancyEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RelevancyEnablerQueryInspector	getRelevancyEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RelevancyEnablerList	getRelevancyEnablers()	Gets the RelevancyEnablerList resulting from a search.
RelevancyEnablerSearchResultsRecord	getRelevancyEnablerSearchResultsRecord(Type relevancyEnablerSearchRecordType)	Gets the relevancy enabler search results record corresponding to the given relevancy enabler 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

getRelevancyEnablers

RelevancyEnablerList getRelevancyEnablers()

Gets the RelevancyEnablerList resulting from a search.

Returns:

the relevancy enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRelevancyEnablerQueryInspector

RelevancyEnablerQueryInspector getRelevancyEnablerQueryInspector()

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

Returns:

the relevancy enabler query inspector

Compliance:

mandatory - This method must be implemented.

getRelevancyEnablerSearchResultsRecord

RelevancyEnablerSearchResultsRecord getRelevancyEnablerSearchResultsRecord(Type relevancyEnablerSearchRecordType)
                                                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

relevancyEnablerSearchRecordType - a relevancy enabler search record type

Returns:

the relevancy enabler search results record

Throws:

NullArgumentException - relevancyEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(relevancyEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.