workflow::state::fsm::edit (public)

 workflow::state::fsm::edit [ -operation operation ] \
    [ -state_id state_id ] [ -workflow_id workflow_id ] \
    [ -array array ] [ -internal ] [ -no_complain ] \
    [ -handlers handlers ]

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

Edit a workflow state. Attributes of the array are:

• short_name
• pretty_name
• sort_order
• hide_fields
• parent_action

Switches:

-operation (optional, defaults to "update")

insert, update, delete

-state_id (optional)

For update/delete: The state to update or delete. For insert: Optionally specify a pre-generated state_id for the state.

-workflow_id (optional)

For update/delete: Optionally specify the workflow_id. If not specified, we will execute a query to find it. For insert: The workflow_id of the new state.

-array (optional)

For insert/update: Name of an array in the caller's namespace with attributes to insert/update.

-internal (optional, boolean)

Set this flag if you're calling this proc from within the corresponding proc for a particular workflow model. Will cause this proc to not flush the cache or call workflow::definition_changed_handler, which the caller must then do.

-no_complain (optional, boolean)

Silently ignore extra attributes that we don't know how to handle.

-handlers (optional)

Returns:

state_id

Authors:

Peter Marklund

Lars Pind <lars@collaboraid.biz>

See Also:

• workflow::state::new

Testcases:

No testcase defined.