org.osid.process

Interface Process

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Process
extends OsidCatalog

A process defines a collection of states.

Method Summary

Methods

Modifier and Type	Method and Description
ProcessRecord	getProcessRecord(Type processRecordType) Gets the process record corresponding to the given Process 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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getProcessRecord

ProcessRecord getProcessRecord(Type processRecordType)
                               throws OperationFailedException

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

Parameters:

processRecordType - the process record type

Returns:

the process record

Throws:

NullArgumentException - processRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processRecordType) is false

Compliance:

mandatory - This method must be implemented.