workflow::case::fsm::get_element (public)

 workflow::case::fsm::get_element -case_id case_id -element element \
    [ -parent_enabled_action_id parent_enabled_action_id ] \
    [ -action_id action_id ]

Defined in packages/workflow/tcl/case-procs.tcl

Return a single element from the information about a case.

Switches:

-case_id

(required)

The ID of the case

-element

(required)

The element you want

-parent_enabled_action_id

(optional)

-action_id

(optional)

If specified, will return the case information as if the given action had already been executed. This is useful for presenting forms for actions that do not take place until the user hits OK.

Returns:

The element you asked for

Author:

Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Source code:

    get -case_id $case_id -parent_enabled_action_id $parent_enabled_action_id -action_id $action_id -array row
    return $row($element)

Generic XQL file:

packages/workflow/tcl/case-procs.xql

PostgreSQL XQL file:

packages/workflow/tcl/case-procs-postgresql.xql

Oracle XQL file:

packages/workflow/tcl/case-procs-oracle.xql