Interface IssueProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface IssueProcessorEnablerSearch
extends OsidSearch

The search interface for governing issue processor enabler searches.

Method Summary

Modifier and Type	Method	Description
IssueProcessorEnablerSearchRecord	getIssueProcessorEnablerSearchRecord(Type issueProcessorEnablerSearchRecordType)	Gets the issue processor enabler search record corresponding to the given issue processor enabler search record Type.
void	orderIssueProcessorEnablerResults(IssueProcessorEnablerSearchOrder issueProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongIssueProcessorEnablers(IdList issueProcessorEnablerIds)	Execute this search among the given list of issue processor enablers.

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

searchAmongIssueProcessorEnablers

void searchAmongIssueProcessorEnablers(IdList issueProcessorEnablerIds)

Execute this search among the given list of issue processor enablers.

Parameters:

issueProcessorEnablerIds - list of issue processor enablers

Throws:

NullArgumentException - issueProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderIssueProcessorEnablerResults

void orderIssueProcessorEnablerResults(IssueProcessorEnablerSearchOrder issueProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

issueProcessorEnablerSearchOrder - issue processor enabler search order

Throws:

NullArgumentException - issueProcessorEnablerSearchOrder is null

UnsupportedException - issueProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getIssueProcessorEnablerSearchRecord

IssueProcessorEnablerSearchRecord getIssueProcessorEnablerSearchRecord(Type issueProcessorEnablerSearchRecordType)
                                                                throws OperationFailedException

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

Parameters:

issueProcessorEnablerSearchRecordType - an issue processor enabler search record type

Returns:

the issue processor enabler search record

Throws:

NullArgumentException - issueProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.