workflow::case::get (public)

 workflow::case::get -case_id case_id -array array \
    [ -action_id action_id ]

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

Get information about a case. Implemented by workflow::case::fsm::get, because we do not yet support multiple workflow engines.

Switches:

-case_id (required)

The case ID

-array (required)

The name of an array in which information will be returned.

-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.

Author:

Lars Pind <lars@collaboraid.biz>

See Also:

• workflow::case::fsm::get

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

Testcases:

No testcase defined.

Source code:

    # Select the info into the upvar'ed Tcl Array
    upvar $array row

    workflow::case::fsm::get -case_id $case_id -array row -action_id $action_id

    # TODO: Should we redesign the API so that it's polymorphic, wrt. to workflow type (FSM/Petri Net)
    # That way, you'd call workflow::case::get and get a state_pretty pseudocolumn, which would be
    # the pretty-name of the state in an FSM, but it would be some kind of human-readable summary of
    # the active tokens in a petri net.

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