org.osid.configuration.rules

Interface ValueEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ValueEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ValueEnablerQueryInspector	getValueEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ValueEnablerList	getValueEnablers() Gets the ValueEnablerList resulting from a search.
ValueEnablerSearchResultsRecord	getValueEnablerSearchResultsRecord(Type valueEnablerSearchRecordType) Gets the value enabler search results record corresponding to the given value 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

getValueEnablers

ValueEnablerList getValueEnablers()

Gets the ValueEnablerList resulting from a search.

Returns:

the value enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getValueEnablerQueryInspector

ValueEnablerQueryInspector getValueEnablerQueryInspector()

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

Returns:

the value enabler query inspector

Compliance:

mandatory - This method must be implemented.

getValueEnablerSearchResultsRecord

ValueEnablerSearchResultsRecord getValueEnablerSearchResultsRecord(Type valueEnablerSearchRecordType)
                                                                   throws OperationFailedException,
                                                                          PermissionDeniedException

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

Parameters:

valueEnablerSearchRecordType - a value enabler search record type

Returns:

the value enabler search results record

Throws:

NullArgumentException - valueEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(valueEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.