workflow::action::fsm::get_element (public)

 workflow::action::fsm::get_element [ -action_id action_id ] \
    [ -one_id one_id ] -element element

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

Return element from information about an action with a given id, including FSM-related info such as 'enabled_in_states', and 'new_state'. Return a single element from the information about a action.

Switches:

-action_id (optional)

The ID of the action

-one_id (optional)

Same as action_id, just used for consistency across roles/actions/states.

-element (required)

The element you want

Returns:

The element you asked for

Authors:

Peter Marklund

Lars Pind <lars@collaboraid.biz>

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

Testcases:

No testcase defined.

Source code:

    if { $action_id eq "" } {
        if { $one_id eq "" } {
            error "You must supply either action_id or one_id"
        }
        set action_id $one_id
    } else {
        if { $one_id ne "" } {
            error "You can only supply either action_id or one_id"
        }
    }
    workflow::action::fsm::get -action_id $action_id -array row
    return $row($element)

Generic XQL file:

packages/workflow/tcl/action-procs.xql

PostgreSQL XQL file:

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

Oracle XQL file:

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