OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.State
Implementsosid.OsidObject
Description

A State represents a stage in a process.

MethodgetStateRecord
Description

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 .

Parametersosid.type.TypestateRecordTypethe state record type
Returnosid.process.records.StateRecordthe state record
ErrorsNULL_ARGUMENT stateRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stateRecordType) is false
CompliancemandatoryThis method must be implemented.