org.osid.ontology.rules

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

Methods

Modifier and Type	Method and 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 org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.