Interface IssueEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface IssueEnablerSearch
extends OsidSearch

The search interface for governing issue enabler searches.

Method Summary

Modifier and Type	Method	Description
IssueEnablerSearchRecord	getIssueEnablerSearchRecord(Type issueEnablerSearchRecordType)	Gets the issue enabler search record corresponding to the given issue enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderIssueEnablerResults(IssueEnablerSearchOrder issueEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongIssueEnablers(IdList issueEnablerIds)	Execute this search among the given list of issue 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

searchAmongIssueEnablers

void searchAmongIssueEnablers(IdList issueEnablerIds)

Execute this search among the given list of issue enablers.

Parameters:

issueEnablerIds - list of issue enablers

Throws:

NullArgumentException - issueEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderIssueEnablerResults

void orderIssueEnablerResults(IssueEnablerSearchOrder issueEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

issueEnablerSearchOrder - issue enabler search order

Throws:

NullArgumentException - issueEnablerSearchOrder is null

UnsupportedException - issueEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getIssueEnablerSearchRecord

IssueEnablerSearchRecord getIssueEnablerSearchRecord(Type issueEnablerSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

issueEnablerSearchRecordType - an issue enabler search record type

Returns:

the issue enabler search record

Throws:

NullArgumentException - issueEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.