role-procs.tcl


	The Toolkit for Online Communities 15896 Community Members, 0 members online, 2312 visitors today			Log In	Register

role-procs.tcl

OpenACS Home : ACS API Browser : Workflow 2.1.1 : role-procs.tcl

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.22 2004/01/27 15:42:21 lars Exp $

Procedures in this file

workflow::role::callback_insert (public)
workflow::role::delete (public)
workflow::role::edit (public)
workflow::role::generate_short_name (public)
workflow::role::get (public)
workflow::role::get_element (public)
workflow::role::get_existing_short_names (public)
workflow::role::get_id (public)
workflow::role::get_options (public)
workflow::role::get_workflow_id (public)
workflow::role::new (public)

Detailed information

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>

workflow::role::delete (public)

workflow::role::delete -role_id role_id

Delete workflow role with given id.

Switches:

-role_id (required)

Author:
Peter Marklund

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:
workflow::role::new

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.

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

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>

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.

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>

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>

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

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>