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

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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,
PermissionDeniedException

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 - an issue search record type

Returns:

the issue search results record

Throws:

NullArgumentException - issueSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(issueSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.