OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Interfaceosid.hold.rules.IssueConstrainerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.hold.rules.IssueConstrainerSearchSession
Description

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

MethodgetIssueConstrainers
Description

Gets the issue constrainer list resulting from a search.

Returnosid.hold.rules.IssueConstrainerListthe issue constrainer list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetIssueConstrainerQueryInspector
Description

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

Returnosid.hold.rules.IssueConstrainerQueryInspectorthe issue constrainer query inspector
CompliancemandatoryThis method must be implemented.
MethodgetIssueConstrainerSearchResultsRecord
Description

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

Parametersosid.type.TypeissueConstrainerSearchRecordTypean issue constrainer search record type
Returnosid.hold.rules.records.IssueConstrainerSearchResultsRecordthe issue constrainer search results record
ErrorsNULL_ARGUMENTissueConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(issueConstrainerSearchRecordTypee) is false
CompliancemandatoryThis method must be implemented.