org.osid.control.rules

Interface ActionEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ActionEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ActionEnablerQueryInspector	getActionEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ActionEnablerList	getActionEnablers() Gets the ActionEnablerList resulting from a search.
ActionEnablerSearchResultsRecord	getActionEnablerSearchResultsRecord(Type actionEnablerSearchRecordType) Gets the action enabler search results record corresponding to the given action 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

getActionEnablers

ActionEnablerList getActionEnablers()

Gets the ActionEnablerList resulting from a search.

Returns:

the action enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getActionEnablerQueryInspector

ActionEnablerQueryInspector getActionEnablerQueryInspector()

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

Returns:

the action enabler query inspector

Compliance:

mandatory - This method must be implemented.

getActionEnablerSearchResultsRecord

ActionEnablerSearchResultsRecord getActionEnablerSearchResultsRecord(Type actionEnablerSearchRecordType)
                                                                     throws OperationFailedException,
                                                                            PermissionDeniedException

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

Parameters:

actionEnablerSearchRecordType - an action enabler search record type

Returns:

the action enabler search results record

Throws:

NullArgumentException - actionEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(actionEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.