OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Interfaceosid.hold.rules.IssueProcessorEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.hold.rules.IssueProcessorEnablerSearchSession
Description

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

MethodgetIssueProcessorEnablers
Description

Gets the issue processor enabler list resulting from a search.

Returnosid.hold.rules.IssueProcessorEnablerListthe issue processor enabler list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetIssueProcessorEnablerQueryInspector
Description

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

Returnosid.hold.rules.IssueProcessorEnablerQueryInspectorthe issue processor enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetIssueProcessorEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypeissueProcessorEnablerSearchRecordTypean issue processor enabler search record type
Returnosid.hold.rules.records.IssueProcessorEnablerSearchResultsRecordthe issue processor enabler search results record
ErrorsNULL_ARGUMENTissueProcessorEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(issueProcessorEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.