Interface ProcessEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProcessEnablerSearch
extends OsidSearch

The search interface for governing process enabler searches.

Method Summary

Modifier and Type	Method	Description
ProcessEnablerSearchRecord	getProcessEnablerSearchRecord(Type processEnablerSearchRecordType)	Gets the process enabler search record corresponding to the given process enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderProcessEnablerResults(ProcessEnablerSearchOrder processEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongProcessEnablers(IdList officeIds)	Execute this search among the given list of process 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

searchAmongProcessEnablers

void searchAmongProcessEnablers(IdList officeIds)

Execute this search among the given list of process enablers.

Parameters:

officeIds - list of process enablers

Throws:

NullArgumentException - officeIds is null

Compliance:

mandatory - This method must be implemented.

orderProcessEnablerResults

void orderProcessEnablerResults(ProcessEnablerSearchOrder processEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

processEnablerSearchOrder - process enabler search order

Throws:

NullArgumentException - processEnablerSearchOrder is null

UnsupportedException - processEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProcessEnablerSearchRecord

ProcessEnablerSearchRecord getProcessEnablerSearchRecord(Type processEnablerSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

processEnablerSearchRecordType - a process enabler search record type

Returns:

the process enabler search record

Throws:

NullArgumentException - processEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.