org.osid.control.rules

Interface ActionEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ActionEnablerSearch
extends OsidSearch

The search interface for governing action enabler searches.

Method Summary

Methods

Modifier and Type	Method and Description
ActionEnablerSearchRecord	getActionEnablerSearchRecord(Type actionEnablerSearchRecordType) Gets the action enabler search record corresponding to the given action enabler search record Type.
void	orderActionEnablerResults(ActionEnablerSearchOrder actionEnablerSearchOrder) Specify an ordering to the search results.
void	searchAmongActionEnablers(IdList actionEnablerIds) Execute this search among the given list of action enablers.

Methods inherited from interface org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

searchAmongActionEnablers

void searchAmongActionEnablers(IdList actionEnablerIds)

Execute this search among the given list of action enablers.

Parameters:

actionEnablerIds - list of action enablers

Throws:

NullArgumentException - actionEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderActionEnablerResults

void orderActionEnablerResults(ActionEnablerSearchOrder actionEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

actionEnablerSearchOrder - action enabler search order

Throws:

NullArgumentException - actionEnablerSearchOrder is null

UnsupportedException - actionEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getActionEnablerSearchRecord

ActionEnablerSearchRecord getActionEnablerSearchRecord(Type actionEnablerSearchRecordType)
                                                       throws OperationFailedException

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

Parameters:

actionEnablerSearchRecordType - an action enabler search record type

Returns:

the action enabler search record

Throws:

NullArgumentException - actionEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.