OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.ActionGroupSearchResults
Implementsosid.OsidSearchResults
Used Byosid.control.ActionGroupSearchSession
Description

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

MethodgetActionGroups
Description

Gets the action group list resulting from a search.

Returnosid.control.ActionGroupList the action group list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetActionGroupQueryInspector
Description

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

Returnosid.control.ActionGroupQueryInspector the action group query inspector
Compliancemandatory This method must be implemented.
MethodgetActionGroupSearchResultsRecord
Description

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

Parametersosid.type.TypeactionGroupSearchRecordType an action group search record type
Returnosid.control.records.ActionGroupSearchResultsRecord the action group search results record
ErrorsNULL_ARGUMENT actionGroupSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(actionGroupSearchRecordType) is false
Compliancemandatory This method must be implemented.