Interface ProcessConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProcessConstrainerSearch
extends OsidSearch

The search interface for governing process constrainer searches.

Method Summary

Modifier and Type	Method	Description
ProcessConstrainerSearchRecord	getProcessConstrainerSearchRecord(Type processConstrainerSearchRecordType)	Gets the process constrainer search record corresponding to the given process constrainer search record Type.
void	orderProcessConstrainerResults(ProcessConstrainerSearchOrder processConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongProcessConstrainers(IdList processConstrainerIds)	Execute this search among the given list of process constrainers.

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

searchAmongProcessConstrainers

void searchAmongProcessConstrainers(IdList processConstrainerIds)

Execute this search among the given list of process constrainers.

Parameters:

processConstrainerIds - list of process constrainer

Throws:

NullArgumentException - processConstrainerIds is null

Compliance:

mandatory - This method must be implemented.

orderProcessConstrainerResults

void orderProcessConstrainerResults(ProcessConstrainerSearchOrder processConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

processConstrainerSearchOrder - process constrainer search order

Throws:

NullArgumentException - processConstrainerSearchOrder is null

UnsupportedException - processConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProcessConstrainerSearchRecord

ProcessConstrainerSearchRecord getProcessConstrainerSearchRecord(Type processConstrainerSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

processConstrainerSearchRecordType - a process constrainer search record type

Returns:

the process constrainer search record

Throws:

NullArgumentException - processConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.