• Publicity: Public Only All

role-procs.tcl

Procedures in the workflow::role namespace.

Location:
packages/workflow/tcl/role-procs.tcl
Created:
8 January 2003
Authors:
Lars Pind <lars@collaboraid.biz>
Peter Marklund <peter@collaboraid.biz>
CVS Identification:
$Id: role-procs.tcl,v 1.29 2018/06/12 08:40:05 gustafn Exp $

Procedures in this file

Detailed information

workflow::role::add_assignee_widgets (public)

 workflow::role::add_assignee_widgets -form_name form_name \
    [ -prefix prefix ] -workflow_id workflow_id [ -roles roles ] \
    [ -mode mode ]

Get the assignee widget for use with ad_form for this role.

Switches:
-form_name
(required)
-prefix
(defaults to "role_") (optional)
-workflow_id
(required)
-roles
(optional)
-mode
(defaults to "display") (optional)
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 packages/bug-tracker/www/bug-add.tcl packages/bug-tracker/ www/bug-add.tcl workflow::role::add_assignee_widgets workflow::role::add_assignee_widgets packages/bug-tracker/www/bug-add.tcl->workflow::role::add_assignee_widgets ad_form ad_form (public) workflow::role::add_assignee_widgets->ad_form workflow::get_roles workflow::get_roles (public) workflow::role::add_assignee_widgets->workflow::get_roles workflow::role::get_assignee_widget workflow::role::get_assignee_widget (public) workflow::role::add_assignee_widgets->workflow::role::get_assignee_widget workflow::role::get_id workflow::role::get_id (public) workflow::role::add_assignee_widgets->workflow::role::get_id

Testcases:
No testcase defined.

workflow::role::callback_insert (public)

 workflow::role::callback_insert -role_id role_id -name name \
    [ -sort_order sort_order ]

Add an assignment rule to a role.

Switches:
-role_id
(required)
The ID of the role
-name
(required)
Name of service contract implementation, in the form (impl_owner_name).(impl_name), for example, bug-tracker.ComponentMaintainer.
-sort_order
(optional)
The sort_order for the rule. Leave blank to add to the end of the list
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::role::edit workflow::role::edit (public) workflow::role::callback_insert workflow::role::callback_insert workflow::role::edit->workflow::role::callback_insert db_dml db_dml (public) workflow::role::callback_insert->db_dml db_string db_string (public) workflow::role::callback_insert->db_string db_transaction db_transaction (public) workflow::role::callback_insert->db_transaction workflow::role::flush_cache workflow::role::flush_cache (private) workflow::role::callback_insert->workflow::role::flush_cache workflow::role::get_workflow_id workflow::role::get_workflow_id (public) workflow::role::callback_insert->workflow::role::get_workflow_id

Testcases:
No testcase defined.

workflow::role::delete (public)

 workflow::role::delete -role_id role_id

Delete workflow role with given id.

Switches:
-role_id
(required)
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::role::edit workflow::role::edit (public) workflow::role::delete workflow::role::delete workflow::role::edit->workflow::role::delete

Testcases:
No testcase defined.

workflow::role::edit (public)

 workflow::role::edit [ -operation operation ] [ -role_id role_id ] \
    [ -workflow_id workflow_id ] [ -array array ] [ -internal ] \
    [ -no_complain ] [ -handlers handlers ]

Edit a workflow role. Attributes of the array are: short_name pretty_name sort_order callbacks.

Switches:
-operation
(defaults to "update") (optional)
insert, update, delete
-role_id
(optional)
For update/delete: The role to update or delete. For insert: Optionally specify a pre-generated role_id for the role.
-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 role.
-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:
role_id
Authors:
Peter Marklund
Lars Pind <lars@collaboraid.biz>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 packages/workflow/www/admin/delete-confirm.tcl packages/workflow/ www/admin/delete-confirm.tcl workflow::role::edit workflow::role::edit packages/workflow/www/admin/delete-confirm.tcl->workflow::role::edit packages/workflow/www/admin/role-ae.tcl packages/workflow/ www/admin/role-ae.tcl packages/workflow/www/admin/role-ae.tcl->workflow::role::edit workflow::role::delete workflow::role::delete (public) workflow::role::delete->workflow::role::edit workflow::role::new workflow::role::new (public) workflow::role::new->workflow::role::edit db_dml db_dml (public) workflow::role::edit->db_dml db_nextval db_nextval (public) workflow::role::edit->db_nextval db_transaction db_transaction (public) workflow::role::edit->db_transaction workflow::default_sort_order workflow::default_sort_order (private) workflow::role::edit->workflow::default_sort_order workflow::definition_changed_handler workflow::definition_changed_handler (public) workflow::role::edit->workflow::definition_changed_handler

Testcases:
No testcase defined.

workflow::role::generate_short_name (public)

 workflow::role::generate_short_name -workflow_id workflow_id \
    -pretty_name pretty_name [ -short_name short_name ] \
    [ -role_id role_id ]

Generate a unique short_name from pretty_name.

Switches:
-workflow_id
(required)
-pretty_name
(required)
-short_name
(optional)
-role_id
(optional)
If you pass in this, we will allow that role's short_name to be reused.

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::role::edit workflow::role::edit (public) workflow::role::generate_short_name workflow::role::generate_short_name workflow::role::edit->workflow::role::generate_short_name _ _ (public) workflow::role::generate_short_name->_ util_text_to_url util_text_to_url (public) workflow::role::generate_short_name->util_text_to_url workflow::role::get_existing_short_names workflow::role::get_existing_short_names (public) workflow::role::generate_short_name->workflow::role::get_existing_short_names

Testcases:
No testcase defined.

workflow::role::get (public)

 workflow::role::get -role_id role_id -array array

Return information about a role in an array.

Switches:
-role_id
(required)
The ID of the workflow
-array
(required)
Name of the array you want the info returned in
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::search::bug::datasource bug_tracker::search::bug::datasource (private) workflow::role::get workflow::role::get bug_tracker::search::bug::datasource->workflow::role::get packages/workflow/www/admin/role-ae.tcl packages/workflow/ www/admin/role-ae.tcl packages/workflow/www/admin/role-ae.tcl->workflow::role::get packages/workflow/www/admin/workflow-edit.tcl packages/workflow/ www/admin/workflow-edit.tcl packages/workflow/www/admin/workflow-edit.tcl->workflow::role::get workflow::case::role::get_assignee_widget workflow::case::role::get_assignee_widget (public) workflow::case::role::get_assignee_widget->workflow::role::get workflow::case::role::set_assignee_values workflow::case::role::set_assignee_values (public) workflow::case::role::set_assignee_values->workflow::role::get workflow::role::get_all_info workflow::role::get_all_info (private) workflow::role::get->workflow::role::get_all_info workflow::role::get_workflow_id workflow::role::get_workflow_id (public) workflow::role::get->workflow::role::get_workflow_id

Testcases:
No testcase defined.

workflow::role::get_assignee_widget (public)

 workflow::role::get_assignee_widget -role_id role_id \
    [ -prefix prefix ] [ -mode mode ]

Get the assignee widget for use with ad_form for this role.

Switches:
-role_id
(required)
the ID of the role.
-prefix
(defaults to "role_") (optional)
-mode
(defaults to "display") (optional)
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::role::add_assignee_widgets workflow::role::add_assignee_widgets (public) workflow::role::get_assignee_widget workflow::role::get_assignee_widget workflow::role::add_assignee_widgets->workflow::role::get_assignee_widget workflow::role::get workflow::role::get (public) workflow::role::get_assignee_widget->workflow::role::get workflow::role::get_picklist workflow::role::get_picklist (public) workflow::role::get_assignee_widget->workflow::role::get_picklist workflow::role::get_search_query workflow::role::get_search_query (public) workflow::role::get_assignee_widget->workflow::role::get_search_query

Testcases:
No testcase defined.

workflow::role::get_element (public)

 workflow::role::get_element [ -role_id role_id ] [ -one_id one_id ] \
    -element element

Return a single element from the information about a role.

Switches:
-role_id
(optional)
The id of the role to get an element for.
-one_id
(optional)
Same as role_id, just used for consistency across roles/actions/states.
-element
(required)
Returns:
element The element you asked for
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::case::action::notify workflow::case::action::notify (public) workflow::role::get_element workflow::role::get_element workflow::case::action::notify->workflow::role::get_element workflow::role::edit workflow::role::edit (public) workflow::role::edit->workflow::role::get_element workflow::role::get_callbacks workflow::role::get_callbacks (private) workflow::role::get_callbacks->workflow::role::get_element workflow::role::get_existing_short_names workflow::role::get_existing_short_names (public) workflow::role::get_existing_short_names->workflow::role::get_element workflow::role::get workflow::role::get (public) workflow::role::get_element->workflow::role::get

Testcases:
No testcase defined.

workflow::role::get_existing_short_names (public)

 workflow::role::get_existing_short_names -workflow_id workflow_id \
    [ -ignore_role_id ignore_role_id ]

Returns a list of existing role 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_role_id
(optional)
If specified, the short_name for the given role will not be included in the result set.

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::role::generate_short_name workflow::role::generate_short_name (public) workflow::role::get_existing_short_names workflow::role::get_existing_short_names workflow::role::generate_short_name->workflow::role::get_existing_short_names workflow::get_roles workflow::get_roles (public) workflow::role::get_existing_short_names->workflow::get_roles workflow::role::get_element workflow::role::get_element (public) workflow::role::get_existing_short_names->workflow::role::get_element

Testcases:
No testcase defined.

workflow::role::get_id (public)

 workflow::role::get_id -workflow_id workflow_id -short_name short_name

Return the role_id of the role with the given short_name in the given workflow.

Switches:
-workflow_id
(required)
The ID of the workflow
-short_name
(required)
The short_name of the role
Returns:
role_id of the desired role, or the empty string if it can't be found.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::action::edit workflow::action::edit (public) workflow::role::get_id workflow::role::get_id workflow::action::edit->workflow::role::get_id workflow::case::role::assign workflow::case::role::assign (public) workflow::case::role::assign->workflow::role::get_id workflow::role::add_assignee_widgets workflow::role::add_assignee_widgets (public) workflow::role::add_assignee_widgets->workflow::role::get_id workflow::role::get_all_info workflow::role::get_all_info (private) workflow::role::get_id->workflow::role::get_all_info

Testcases:
No testcase defined.

workflow::role::get_options (public)

 workflow::role::get_options -workflow_id workflow_id [ -id_values ]

Get a list of roles in a workflow for use in the 'options' property of a form builder form element.

Switches:
-workflow_id
(required)
-id_values
(boolean) (optional)
Provide this switch if you want the values in the options list to be role id:s instead of short names.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 packages/workflow/www/admin/action-ae.tcl packages/workflow/ www/admin/action-ae.tcl workflow::role::get_options workflow::role::get_options packages/workflow/www/admin/action-ae.tcl->workflow::role::get_options workflow::get_roles workflow::get_roles (public) workflow::role::get_options->workflow::get_roles workflow::role::get workflow::role::get (public) workflow::role::get_options->workflow::role::get

Testcases:
No testcase defined.

workflow::role::get_picklist (public)

 workflow::role::get_picklist -role_id role_id

Get the picklist for this role.

Switches:
-role_id
(required)
the ID of the role.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::role::get_assignee_widget workflow::role::get_assignee_widget (public) workflow::role::get_picklist workflow::role::get_picklist workflow::role::get_assignee_widget->workflow::role::get_picklist acs_sc::invoke acs_sc::invoke (public) workflow::role::get_picklist->acs_sc::invoke ad_conn ad_conn (public) workflow::role::get_picklist->ad_conn db_list_of_lists db_list_of_lists (public) workflow::role::get_picklist->db_list_of_lists db_transaction db_transaction (public) workflow::role::get_picklist->db_transaction workflow::role::get_callbacks workflow::role::get_callbacks (private) workflow::role::get_picklist->workflow::role::get_callbacks

Testcases:
No testcase defined.

workflow::role::get_search_query (public)

 workflow::role::get_search_query -role_id role_id

Get the search query for this role.

Switches:
-role_id
(required)
the ID of the role.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::role::get_assignee_widget workflow::role::get_assignee_widget (public) workflow::role::get_search_query workflow::role::get_search_query workflow::role::get_assignee_widget->workflow::role::get_search_query workflow::role::get_callbacks workflow::role::get_callbacks (private) workflow::role::get_search_query->workflow::role::get_callbacks workflow::service_contract::role_assignee_subquery workflow::service_contract::role_assignee_subquery (public) workflow::role::get_search_query->workflow::service_contract::role_assignee_subquery

Testcases:
No testcase defined.

workflow::role::get_workflow_id (public)

 workflow::role::get_workflow_id -role_id role_id

Lookup the workflow_id of a certain role_id.

Switches:
-role_id
(required)
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::impl::role_assignee_pick_list::current_assignees::get_pick_list workflow::impl::role_assignee_pick_list::current_assignees::get_pick_list (public) workflow::role::get_workflow_id workflow::role::get_workflow_id workflow::impl::role_assignee_pick_list::current_assignees::get_pick_list->workflow::role::get_workflow_id workflow::role::callback_insert workflow::role::callback_insert (public) workflow::role::callback_insert->workflow::role::get_workflow_id workflow::role::get workflow::role::get (public) workflow::role::get->workflow::role::get_workflow_id util_memoize util_memoize (public) workflow::role::get_workflow_id->util_memoize workflow::role::get_workflow_id_not_cached workflow::role::get_workflow_id_not_cached (private) workflow::role::get_workflow_id->workflow::role::get_workflow_id_not_cached

Testcases:
No testcase defined.

workflow::role::new (public)

 workflow::role::new -workflow_id workflow_id [ -role_id role_id ] \
    [ -short_name short_name ] -pretty_name pretty_name \
    [ -sort_order sort_order ] [ -callbacks callbacks ]

Creates a new role for a workflow.

Switches:
-workflow_id
(required)
The ID of the workflow the new role belongs to
-role_id
(optional)
-short_name
(optional)
The short_name of the new role
-pretty_name
(required)
The pretty name of the new role
-sort_order
(optional)
-callbacks
(optional)
A list of names service-contract implementations.
Returns:
role_id
Authors:
Peter Marklund
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::role::parse_spec workflow::role::parse_spec (private) workflow::role::new workflow::role::new workflow::role::parse_spec->workflow::role::new workflow::test::workflow_setup workflow::test::workflow_setup (public) workflow::test::workflow_setup->workflow::role::new workflow::role::edit workflow::role::edit (public) workflow::role::new->workflow::role::edit

Testcases:
No testcase defined.
[ show source ]