org.osid.tracking

Interface IssueSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface IssueSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
IssueQueryInspector	getIssueQueryInspector() Gets the inspector for the query to examine the terms used in the search.
IssueList	getIssues() Gets the issue list resulting from a search.
IssueSearchResultsRecord	getIssueSearchResultsRecord(Type issueSearchRecordType) Gets the issue search results record corresponding to the given issue search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getIssues

IssueList getIssues()

Gets the issue list resulting from a search.

Returns:

the issue list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getIssueQueryInspector

IssueQueryInspector getIssueQueryInspector()

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

Returns:

the issue query inspector

Compliance:

mandatory - This method must be implemented.

getIssueSearchResultsRecord

IssueSearchResultsRecord getIssueSearchResultsRecord(Type issueSearchRecordType)
                                                     throws OperationFailedException

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.

Parameters:

issueSearchRecordType - a issue search record type

Returns:

the issue search results record

Throws:

NullArgumentException - issueSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.