org.osid.workflow

Interface WorkSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface WorkSearch
extends OsidSearch

The search interface for governing work searches.

Method Summary

Methods

Modifier and Type	Method and Description
WorkSearchRecord	getWorkSearchRecord(Type workSearchRecordType) Gets the work search record corresponding to the given work search record Type.
void	orderWorkResults(WorkSearchOrder workSearchOrder) Specify an ordering to the search results.
void	searchAmongWorks(IdList workIds) Execute this search among the given list of works.

Methods inherited from interface org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

searchAmongWorks

void searchAmongWorks(IdList workIds)

Execute this search among the given list of works.

Parameters:

workIds - list of works

Throws:

NullArgumentException - workIds is null

Compliance:

mandatory - This method must be implemented.

orderWorkResults

void orderWorkResults(WorkSearchOrder workSearchOrder)

Specify an ordering to the search results.

Parameters:

workSearchOrder - work search order

Throws:

NullArgumentException - workSearchOrder is null

UnsupportedException - workSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getWorkSearchRecord

WorkSearchRecord getWorkSearchRecord(Type workSearchRecordType)
                                     throws OperationFailedException

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

Parameters:

workSearchRecordType - a work search record type

Returns:

the work search record

Throws:

NullArgumentException - workSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.