OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.IssueSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetIssues
Description

Gets the issue list resulting from a search.

Returnosid.hold.IssueListthe issue list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetIssueQueryInspector
Description

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

Returnosid.hold.IssueQueryInspectorthe issue query inspector
CompliancemandatoryThis method must be implemented.
MethodgetIssueSearchResultsRecord
Description

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

Parametersosid.type.TypeissueSearchRecordTypean issue search record type
Returnosid.hold.records.IssueSearchResultsRecordthe issue search results record
ErrorsNULL_ARGUMENT issueSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(issueSearchRecordType) is false
CompliancemandatoryThis method must be implemented.