Interface ActionGroupSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ActionGroupSearch
extends OsidSearch

The search interface for governing action group searches.

Method Summary

Modifier and Type	Method	Description
ActionGroupSearchRecord	getActionGroupSearchRecord(Type actionGroupSearchRecordType)	Gets the action group search record corresponding to the given action group search record Type .This method is used to retrieve an object implementing the requested record.
void	orderActionGroupResults(ActionGroupSearchOrder actionGroupSearchOrder)	Specify an ordering to the search results.
void	searchAmongActionGroups(IdList actionGroupIds)	Execute this search among the given list of action groups.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongActionGroups

void searchAmongActionGroups(IdList actionGroupIds)

Execute this search among the given list of action groups.

Parameters:

actionGroupIds - list of action groups

Throws:

NullArgumentException - actionGroupIds is null

Compliance:

mandatory - This method must be implemented.

orderActionGroupResults

void orderActionGroupResults(ActionGroupSearchOrder actionGroupSearchOrder)

Specify an ordering to the search results.

Parameters:

actionGroupSearchOrder - action group search order

Throws:

NullArgumentException - actionGroupSearchOrder is null

UnsupportedException - actionGroupSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getActionGroupSearchRecord

ActionGroupSearchRecord getActionGroupSearchRecord(Type actionGroupSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

actionGroupSearchRecordType - an action group search record type

Returns:

the action group search record

Throws:

NullArgumentException - actionGroupSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionGroupSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.