Interface IssueProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface IssueProcessorSearch
extends OsidSearch

The search interface for governing issue processor searches.

Method Summary

Modifier and Type	Method	Description
IssueProcessorSearchRecord	getIssueProcessorSearchRecord(Type issueProcessorSearchRecordType)	Gets the issue processor search record corresponding to the given issue processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderIssueProcessorResults(IssueProcessorSearchOrder issueProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongIssueProcessors(IdList issueProcessorIds)	Execute this search among the given list of issue processors.

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

searchAmongIssueProcessors

void searchAmongIssueProcessors(IdList issueProcessorIds)

Execute this search among the given list of issue processors.

Parameters:

issueProcessorIds - list of issue processors

Throws:

NullArgumentException - issueProcessorIds is null

Compliance:

mandatory - This method must be implemented.

orderIssueProcessorResults

void orderIssueProcessorResults(IssueProcessorSearchOrder issueProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

issueProcessorSearchOrder - issue processor search order

Throws:

NullArgumentException - issueProcessorSearchOrder is null

UnsupportedException - issueProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getIssueProcessorSearchRecord

IssueProcessorSearchRecord getIssueProcessorSearchRecord(Type issueProcessorSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

issueProcessorSearchRecordType - an issue processor search record type

Returns:

the issue processor search record

Throws:

NullArgumentException - issueProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.