- Publicity: Public Only All
state-procs.tcl
Procedures in the workflow::fsm::state namespace and in its child namespaces.
- Location:
- packages/workflow/tcl/state-procs.tcl
- Created:
- 8 January 2003
- Authors:
- Lars Pind <lars@collaboraid.biz>
- Peter Marklund <peter@collaboraid.biz>
- CVS Identification:
$Id: state-procs.tcl,v 1.25 2022/09/28 09:12:55 gustafn Exp $
Procedures in this file
- workflow::state::fsm::edit (public)
- workflow::state::fsm::generate_short_name (public)
- workflow::state::fsm::get (public)
- workflow::state::fsm::get_element (public)
- workflow::state::fsm::get_existing_short_names (public)
- workflow::state::fsm::get_id (public)
- workflow::state::fsm::get_workflow_id (public)
- workflow::state::fsm::new (public)
- workflow::state::fsm::pretty_name_unique_p (public)
Detailed information
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 ]
Edit a workflow state. Attributes of the array are:
- short_name
- pretty_name
- sort_order
- hide_fields
- parent_action
- Switches:
- -operation
(defaults to"update"
) (optional)- 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
(boolean) (optional)- 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
(boolean) (optional)- 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
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
workflow::state::fsm::generate_short_name (public)
workflow::state::fsm::generate_short_name -workflow_id workflow_id \ -pretty_name pretty_name [ -short_name short_name ] \ [ -state_id state_id ]
Generate a unique short_name from pretty_name.
- Switches:
- -workflow_id
(required)- -pretty_name
(required)- -short_name
(optional)- -state_id
(optional)- If you pass in this, we will allow that state's short_name to be reused.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
workflow::state::fsm::get (public)
workflow::state::fsm::get -state_id state_id -array array
Return workflow_id, sort_order, short_name, and pretty_name for a certain FSM workflow state.
- Switches:
- -state_id
(required)- -array
(required)- Author:
- Peter Marklund
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
workflow::state::fsm::get_element (public)
workflow::state::fsm::get_element [ -state_id state_id ] \ [ -one_id one_id ] -element element
Return a single element from the information about a state.
- Switches:
- -state_id
(optional)- The ID of the workflow
- -one_id
(optional)- Same as state_id, just used for consistency across roles/actions/states.
- -element
(required)- Returns:
- The element you asked for
- Author:
- Lars Pind <lars@collaboraid.biz>
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
workflow::state::fsm::get_existing_short_names (public)
workflow::state::fsm::get_existing_short_names \ -workflow_id workflow_id [ -ignore_state_id ignore_state_id ]
Returns a list of existing state short_names in this workflow. Useful when you're trying to ensure a short_name is unique, or construct a new short_name that is guaranteed to be unique.
- Switches:
- -workflow_id
(required)- -ignore_state_id
(optional)- If specified, the short_name for the given state will not be included in the result set.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
workflow::state::fsm::get_id (public)
workflow::state::fsm::get_id -workflow_id workflow_id \ -short_name short_name
Return the id of the state with given short name
- Switches:
- -workflow_id
(required)- The id of the workflow the state belongs to.
- -short_name
(required)- The name of the state to return the id for.
- Author:
- Peter Marklund
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
workflow::state::fsm::get_workflow_id (public)
workflow::state::fsm::get_workflow_id -state_id state_id
Lookup the workflow that the given state belongs to.
- Switches:
- -state_id
(required)- Returns:
- The id of the workflow the state belongs to.
- Author:
- Peter Marklund
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
workflow::state::fsm::new (public)
workflow::state::fsm::new -workflow_id workflow_id [ -internal ] \ [ -short_name short_name ] -pretty_name pretty_name \ [ -hide_fields hide_fields ] [ -sort_order sort_order ] \ [ -parent_action parent_action ]
Creates a new state for a certain FSM (Finite State Machine) workflow.
- Switches:
- -workflow_id
(required)- The id of the FSM workflow to add the state to
- -internal
(boolean) (optional)- 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.
- -short_name
(optional)- If you leave blank, the short_name will be generated from pretty_name.
- -pretty_name
(required)- -hide_fields
(optional)- A space-separated list of the names of form fields which should be hidden when in this state, because they're irrelevant in a certain state.
- -sort_order
(optional)- The number which this state should be in the sort ordering sequence. Leave blank to add state at the end. If you provide a sort_order number which already exists, existing states are pushed down one number.
- -parent_action
(optional)- Which action with trigger_type 'workflow' does this state belong to.
- Returns:
- ID of new state.
- Author:
- Peter Marklund
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
workflow::state::fsm::pretty_name_unique_p (public)
workflow::state::fsm::pretty_name_unique_p -workflow_id workflow_id \ -pretty_name pretty_name [ -parent_action_id parent_action_id ] \ [ -state_id state_id ]
Check if suggested pretty_name is unique.
- Switches:
- -workflow_id
(required)- -pretty_name
(required)- -parent_action_id
(optional)- -state_id
(optional)- Returns:
- 1 if unique, 0 if not unique.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.