OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.ActionGroupSearch
Implementsosid.OsidSearch
Description

The search interface for governing action group searches.

MethodsearchAmongActionGroups
Description

Execute this search among the given list of action groups.

Parametersosid.id.IdListactionGroupIdslist of action groups
ErrorsNULL_ARGUMENT actionGroupIds is null
CompliancemandatoryThis method must be implemented.
MethodorderActionGroupResults
Description

Specify an ordering to the search results.

Parametersosid.control.ActionGroupSearchOrderactionGroupSearchOrderaction group search order
ErrorsNULL_ARGUMENT actionGroupSearchOrder is null
UNSUPPORTED actionGroupSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupSearchRecord
Description

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.

Parametersosid.type.TypeactionGroupSearchRecordTypean action group search record type
Returnosid.control.records.ActionGroupSearchRecordthe action group search record
ErrorsNULL_ARGUMENT actionGroupSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(actionGroupSearchRecordType) is false
CompliancemandatoryThis method must be implemented.