Interface ProcessProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProcessProcessorSearch
extends OsidSearch

The search interface for governing process processor searches.

Method Summary

Modifier and Type	Method	Description
ProcessProcessorSearchRecord	getProcessProcessorSearchRecord(Type processProcessorSearchRecordType)	Gets the process processor search record corresponding to the given process processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderProcessProcessorResults(ProcessProcessorSearchOrder processProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongProcessProcessors(IdList processProcessorIds)	Execute this search among the given list of process processors.

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

searchAmongProcessProcessors

void searchAmongProcessProcessors(IdList processProcessorIds)

Execute this search among the given list of process processors.

Parameters:

processProcessorIds - list of process processors

Throws:

NullArgumentException - processProcessorIds is null

Compliance:

mandatory - This method must be implemented.

orderProcessProcessorResults

void orderProcessProcessorResults(ProcessProcessorSearchOrder processProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

processProcessorSearchOrder - process processor search order

Throws:

NullArgumentException - processProcessorSearchOrder is null

UnsupportedException - processProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProcessProcessorSearchRecord

ProcessProcessorSearchRecord getProcessProcessorSearchRecord(Type processProcessorSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

processProcessorSearchRecordType - a process processor search record type

Returns:

the process processor search record

Throws:

NullArgumentException - processProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.