org.osid.workflow

Interface Work

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Work
extends OsidObject

Work moves through Steps in a workflow.

Method Summary

Methods

Modifier and Type	Method and Description
WorkRecord	getWorkRecord(Type workRecordType) Gets the work record corresponding to the given Work record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getWorkRecord

WorkRecord getWorkRecord(Type workRecordType)
                         throws OperationFailedException

Gets the work record corresponding to the given Work record Type. This method is used to retrieve an object implementing the requested record. The workRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(workRecordType) is true .

Parameters:

workRecordType - the type of work record to retrieve

Returns:

the work record

Throws:

NullArgumentException - workRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workRecordType) is false

Compliance:

mandatory - This method must be implemented.