Interface IssueConstrainerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface IssueConstrainerEnablerSearch
extends OsidSearch

The search interface for governing issue constrainer enabler searches.

Method Summary

Modifier and Type	Method	Description
IssueConstrainerEnablerSearchRecord	getIssueConstrainerEnablerSearchRecord(Type issueConstrainerEnablerSearchRecordType)	Gets the issue constrainer enabler search record corresponding to the given issue constrainer enabler search record Type .
void	orderIssueConstrainerEnablerResults(IssueConstrainerEnablerSearchOrder issueConstrainerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongIssueConstrainerEnablers(IdList issueConstrainerEnablerIds)	Execute this search among the given list of issue constrainer 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

searchAmongIssueConstrainerEnablers

void searchAmongIssueConstrainerEnablers(IdList issueConstrainerEnablerIds)

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

Parameters:

issueConstrainerEnablerIds - list of issue constrainer enablers

Throws:

NullArgumentException - issueConstrainerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderIssueConstrainerEnablerResults

void orderIssueConstrainerEnablerResults(IssueConstrainerEnablerSearchOrder issueConstrainerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

issueConstrainerEnablerSearchOrder - issue constrainer enabler search order

Throws:

NullArgumentException - issueConstrainerEnablerSearchOrder is null

UnsupportedException - issueConstrainerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getIssueConstrainerEnablerSearchRecord

IssueConstrainerEnablerSearchRecord getIssueConstrainerEnablerSearchRecord(Type issueConstrainerEnablerSearchRecordType)
                                                                    throws OperationFailedException

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

Parameters:

issueConstrainerEnablerSearchRecordType - an issue constrainer enabler search record type

Returns:

the issue constrainer enabler search record

Throws:

NullArgumentException - issueConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.