Interface ProcessConstrainerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProcessConstrainerEnablerSearch
extends OsidSearch

The search interface for governing process constrainer enabler searches.

Method Summary

Modifier and Type	Method	Description
ProcessConstrainerEnablerSearchRecord	getProcessConstrainerEnablerSearchRecord(Type processConstrainerEnablerSearchRecordType)	Gets the process constrainer enabler search record corresponding to the given process constrainer enabler search record Type.
void	orderProcessConstrainerEnablerResults(ProcessConstrainerEnablerSearchOrder processConstrainerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongProcessConstrainerEnablers(IdList processConstrainerEnablerIds)	Execute this search among the given list of process 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

searchAmongProcessConstrainerEnablers

void searchAmongProcessConstrainerEnablers(IdList processConstrainerEnablerIds)

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

Parameters:

processConstrainerEnablerIds - list of process constrainer enablers

Throws:

NullArgumentException - processConstrainerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderProcessConstrainerEnablerResults

void orderProcessConstrainerEnablerResults(ProcessConstrainerEnablerSearchOrder processConstrainerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

processConstrainerEnablerSearchOrder - process constrainer enabler search order

Throws:

NullArgumentException - processConstrainerEnablerSearchOrder is null

UnsupportedException - processConstrainerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProcessConstrainerEnablerSearchRecord

ProcessConstrainerEnablerSearchRecord getProcessConstrainerEnablerSearchRecord(Type processConstrainerEnablerSearchRecordType)
                                                                        throws OperationFailedException

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

Parameters:

processConstrainerEnablerSearchRecordType - a process constrainer enabler search record type

Returns:

the process constrainer enabler search record

Throws:

NullArgumentException - processConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.