Interface IssueSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface IssueSearch
extends OsidSearch

The search interface for governing issue searches.

Method Summary

Modifier and Type	Method	Description
IssueSearchRecord	getIssueSearchRecord(Type issueSearchRecordType)	Gets the issue search record corresponding to the given issue search record Type.
void	orderIssueResults(IssueSearchOrder issueSearchOrder)	Specify an ordering to the search results.
void	searchAmongIssues(IdList issueIds)	Execute this search among the given list of issues.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongIssues

void searchAmongIssues(IdList issueIds)

Execute this search among the given list of issues.

Parameters:

issueIds - list of issues

Throws:

NullArgumentException - issueIds is null

Compliance:

mandatory - This method must be implemented.

orderIssueResults

void orderIssueResults(IssueSearchOrder issueSearchOrder)

Specify an ordering to the search results.

Parameters:

issueSearchOrder - issue search order

Throws:

NullArgumentException - issueSearchOrder is null

UnsupportedException - issueSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getIssueSearchRecord

IssueSearchRecord getIssueSearchRecord(Type issueSearchRecordType)
                                throws OperationFailedException

Gets the issue search 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 record

Throws:

NullArgumentException - issueSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.