org.osid.workflow

Interface WorkSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface WorkSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
WorkSearchOrderRecord	getWorkSearchOrderRecord(Type workRecordType) Gets the work search order record corresponding to the given work record Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

getWorkSearchOrderRecord

WorkSearchOrderRecord getWorkSearchOrderRecord(Type workRecordType)
                                               throws OperationFailedException

Gets the work search order record corresponding to the given work record Type. Multiple retrievals return the same underlying object.

Parameters:

workRecordType - a work record type

Returns:

the work search order record

Throws:

NullArgumentException - workRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workRecordType) is false

Compliance:

mandatory - This method must be implemented.