org.osid.process

Interface State

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface State
extends OsidObject

A State represents a stage in a process.

Method Summary

Methods

Modifier and Type	Method and Description
StateRecord	getStateRecord(Type stateRecordType) Gets the state record corresponding to the given State 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

getStateRecord

StateRecord getStateRecord(Type stateRecordType)
                           throws OperationFailedException

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

Parameters:

stateRecordType - the state record type

Returns:

the state record

Throws:

NullArgumentException - stateRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stateRecordType) is false

Compliance:

mandatory - This method must be implemented.