OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.ActionGroupSearchResults
Implementsosid.OsidSearchResults
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.ActionGroupListthe action group list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupQueryInspector
Description

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

Returnosid.control.ActionGroupQueryInspectorthe action group query inspector
CompliancemandatoryThis 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.TypeactionGroupSearchRecordTypean action group search record type
Returnosid.control.records.ActionGroupSearchResultsRecordthe action group search results record
ErrorsNULL_ARGUMENT actionGroupSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(actionGroupSearchRecordType) is false
CompliancemandatoryThis method must be implemented.