# RHWorkStatus

Inherits from: RHObject :: RHWrapper

# Class Methods

# Inherited methods

ErrorAssoc OKAssoc

# Destructor

function Void Destructor()

# Overrides:

Destructor in class RHObject

# New

function Dynamic New(Object prgCtx, Dynamic arg1, Dynamic arg2=Undefined, Dynamic arg3=Undefined, Dynamic arg4=$RHCore.Utils.GetRequest(prgCtx))

A many faced constructor for RHWorkStatus.

Usage:

Frame wf = $RHCore.RHWorkStatus.New(prgCtx, &lt;workid&gt;, &lt;subworkid&gt;, &lt;work&gt;)

or, if request has workid and subworkid columns:

Frame wf = $RHCore.RHWorkStatus.New(prgCtx, request)

# Overrides:

New in class RHObject

# NewFromRequest

function Dynamic NewFromRequest(Object prgCtx, Record request=$RHCore.Utils.GetRequest(prgCtx))

@deprecated

# NewFromWorkID

function Dynamic NewFromWorkID(Object prgCtx, Integer workid, Integer subWorkID=workid, Record request=$RHCore.Utils.GetRequest(prgCtx))

# Instance Methods

# Property Methods

Property methods can be accessed with the valueForKey method.

attachmentsfolder attrdata attributes attributevalues audit auditdatelast auditraw cachekey classidentifier classname clone due errorassoc formattrdata hash identityhashcode initiator iterator link loadupdatemap manager mapid mapnode mapobjid maprecord mapstatusinfo menuurl methods multiselect okassoc propertymethods relationship reset serialize startdate status statuscolour statusverbose string subtype subworkid taskrecs tasks title url urlabsolute work workdata workid workrec

# Inherited methods

assert cacheMethod cacheValueForKey callSuper checkError class classIdentifier className clone deserialize dict endTrans identityHashCode isAccessorMethod isCached isInstanceOf isProperty isPropertyMethod isPropertyRelated iterator methods pluck prepareForReuse propertyMethods removeFromCache reset resetCache resolveRelatedProperty respondsTo serialize setCacheValueForKey setValueForKey setValueForKeyPath startTrans super touch valueForKey valueForKeyPath

# attachmentsFolder

function Frame attachmentsFolder()

# attrdata

function Frame attrdata()

# attributes

function Frame attributes()

# attributevalues

function Dynamic attributevalues()

# audit

function RecArray audit()

# auditdatelast

function Date auditdatelast()

Returns the date of the last audit event, including sub-workflows.

# Returns

Returns a date.

# auditraw

function RecArray auditraw()

# cacheKey

function String cacheKey()

# comments

function RecArray comments(Integer workId = .workid())

# commentsSub

function RecArray commentsSub(Integer workId = .workid())

# due

function Date due()

# formAttrdata

function Frame formAttrdata()

Added 30.6.21 but not tested!

# hash

function String hash()

# Overrides:

hash in class RHObject

# initiator

function Frame initiator()

# link

function String link()

# loadUpdateMap

function List loadUpdateMap()

# manager

function Frame manager()

# mapid

function Integer mapid()

# mapNode

function Frame mapNode()

# mapobjid

function Integer mapobjid()

# mapRecord

function Record mapRecord()

# mapStatusInfo

function Assoc mapStatusInfo()

# menuURL

function String menuURL()

# multiselect

function Boolean multiselect()

# primitiveValueForKey

function Dynamic primitiveValueForKey(String key, Dynamic defaultValue=Undefined)

# Overrides:

primitiveValueForKey in class RHWrapper

# relationship

function Dynamic relationship()

# rename

function Assoc rename(String name)

# resetSubclass

function Void resetSubclass()

# Overrides:

resetSubclass in class RHObject

# save

function Assoc save(Dynamic task)

The parameter task is an instance of RHWorkStatusTask.

As of 14.1.19 task can also be a task record (e.g., task.taskRec() or task.taskStatus()). This was changed to accomodate XMLWorkflowExtensions, which assumes a taskStatus record is passed into SaveWork.

# setStatus

function Integer setStatus(Integer status)

# setValues

function Frame setValues(Dynamic values)

# Overrides:

setValues in class RHObject

# setWFStatus

function Integer setStatus(Integer status)

Valid values include:

- WAPI.WORK_STATUS_SUSPENDED
- WAPI.WORK_STATUS_EXECUTING
- WAPI.WORK_STATUS_STOPPED
- WAPI.WORK_STATUS_ARCHIVED
- $WFMain.WFConst.kWFDelete

# startDate

function Date startDate()

# status

function Integer status()

The "sub workflow status", which is different than the "work status". Should match a value from the $RHCore.WorkflowStatusEnum.

# statusColour

function String statusColour()

# statusVerbose

function String statusVerbose()

# string

function String string()

This method returns a string representation of the object.

# Overrides:

string in class RHObject

# subtype

function Integer subtype()

# subworkid

function Integer subworkid()

# taskRecs

function RecArray taskRecs()

# tasks

function Frame tasks(Integer taskid = Undefined)

# title

function String title()

# updateWorkflow

function Assoc updateWorkflow(Integer attribute, Dynamic value)

Attribute:

WAPI.SUBWORK_TITLE WAPI.SUBWORK_PROJECT WAPI.SUBWORK_FLAGS WAPI.SUBWORK_USERDATA WAPI.SUBWORK_CUSTOMDATA

# url

function String url(Boolean absolute=false)

# urlAbsolute

function String urlAbsolute()

# work

function WAPIWORK work()

# workData

function Dynamic workdata(Object pkg=Undefined)

# workid

function Integer workid()

# workRec

function Record workRec()

# workStatus

function Integer workStatus()

Returns the work_status of the workflow. Values should match:

$RHCore.WorkStatusEnum

← RHWorkflowQuery RHWorkStatusTask →