\SeedDMS_Core_Workflow_State

Class to represent a workflow state in the document management system

Summary

Methods
Properties
Constants
SeedDMS_Core_Workflow_State()
setDMS()
getID()
getName()
setName()
getMaxTime()
setMaxTime()
getPreCondFunc()
setPreCondFunc()
getDocumentStatus()
setDocumentStatus()
isUsed()
remove()
$_id
$_name
$_maxtime
$_precondfunc
$_documentstatus
$_dms
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$_id

$_id : integer

Type

integer — id of workflow state

$_name

$_name : \name

Type

\name — of the workflow state

$_maxtime

$_maxtime : \maximum

Type

\maximum — of seconds allowed in this state

$_precondfunc

$_precondfunc : \maximum

Type

\maximum — of seconds allowed in this state

$_documentstatus

$_documentstatus : \matching

Type

\matching — documentstatus when this state is reached

$_dms

$_dms : object

Type

object — reference to the dms instance this attribute belongs to

Methods

SeedDMS_Core_Workflow_State()

SeedDMS_Core_Workflow_State( $id,  $name,  $maxtime,  $precondfunc,  $documentstatus)

Parameters

$id
$name
$maxtime
$precondfunc
$documentstatus

setDMS()

setDMS( $dms)

Parameters

$dms

getID()

getID()

getName()

getName()

setName()

setName( $newName)

Parameters

$newName

getMaxTime()

getMaxTime()

setMaxTime()

setMaxTime( $maxtime)

Parameters

$maxtime

getPreCondFunc()

getPreCondFunc()

setPreCondFunc()

setPreCondFunc( $precondfunc)

Parameters

$precondfunc

getDocumentStatus()

getDocumentStatus() : integer

Get the document status which is set when this state is reached

The document status uses the define states S_REJECTED and S_RELEASED Only those two states will update the document status

Returns

integer —

document status

setDocumentStatus()

setDocumentStatus( $docstatus)

Parameters

$docstatus

isUsed()

isUsed() : boolean

Check if workflow state is currently used by any workflow transition

Returns

boolean —

true if workflow is used, otherwise false

remove()

remove() : boolean

Remove the workflow state

Returns

boolean —

true on success or false in case of an error

    false is also returned if the workflow state is currently in use