bug-procs.tcl

Publicity: Public Only All

bug-procs.tcl

Bug Tracker Bug Library Procedures that deal with a single bug

Location:

packages/bug-tracker/tcl/bug-procs.tcl
Created:

2003-01-10
Author:

Lars Pind
CVS Identification:

$Id$

Procedures in this file

bug_tracker::bug::cache_flush (public)
bug_tracker::bug::capture_resolution_code::do_side_effect (private)
bug_tracker::bug::capture_resolution_code::pretty_name (private)
bug_tracker::bug::delete (public)
bug_tracker::bug::edit (public)
bug_tracker::bug::format_log_title::format_log_title (private)
bug_tracker::bug::format_log_title::pretty_name (private)
bug_tracker::bug::get (public)
bug_tracker::bug::get_bug_numbers (public)
bug_tracker::bug::get_component_maintainer::get_assignees (private)
bug_tracker::bug::get_component_maintainer::pretty_name (private)
bug_tracker::bug::get_instance_workflow_id (public)
bug_tracker::bug::get_list (public)
bug_tracker::bug::get_multirow (public)
bug_tracker::bug::get_package_workflow_id (public)
bug_tracker::bug::get_project_maintainer::get_assignees (private)
bug_tracker::bug::get_project_maintainer::pretty_name (private)
bug_tracker::bug::get_query (public)
bug_tracker::bug::get_watch_link (public)
bug_tracker::bug::insert (public)
bug_tracker::bug::instance_workflow_create (private)
bug_tracker::bug::instance_workflow_delete (private)
bug_tracker::bug::new (public)
bug_tracker::bug::notification_info::get_notification_info (private)
bug_tracker::bug::notification_info::pretty_name (private)
bug_tracker::bug::object_type (public)
bug_tracker::bug::update (public)
bug_tracker::bug::workflow_create (private)
bug_tracker::bug::workflow_delete (private)
bug_tracker::bug::workflow_short_name (public)

Detailed information

bug_tracker::bug::cache_flush (public)

 bug_tracker::bug::cache_flush -bug_id bug_id

Flush all list builder instances and other appropriate things for the given bug-tracker package instance.

Switches:

-bug_id (required)

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

Testcases:
No testcase defined.

bug_tracker::bug::capture_resolution_code::do_side_effect (private)

 bug_tracker::bug::capture_resolution_code::do_side_effect case_id \
    object_id action_id entry_id

Parameters:

case_id (required)

object_id (required)

action_id (required)

entry_id (required)

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

Testcases:
No testcase defined.

bug_tracker::bug::capture_resolution_code::pretty_name (private)

 bug_tracker::bug::capture_resolution_code::pretty_name

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

Testcases:
No testcase defined.

bug_tracker::bug::delete (public)

 bug_tracker::bug::delete bug_id

Delete a Bug Tracker bug. This should only ever be run when un-instantiating a project!

Parameters:

bug_id (required)

Author:

Mark Aufflick

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

Testcases:
No testcase defined.

bug_tracker::bug::edit (public)

 bug_tracker::bug::edit -bug_id bug_id \
    -enabled_action_id enabled_action_id [ -user_id user_id ] \
    [ -creation_ip creation_ip ] -description description \
    -desc_format desc_format -array array [ -entry_id entry_id ]

Edit a bug, then send out notifications, etc. Calls bug_tracker::bug::update.

Switches:

-bug_id (required)
-enabled_action_id (required)
-user_id (optional)
-creation_ip (optional)
-description (required)
-desc_format (required)
-array (required)
-entry_id (optional)

Returns:
bug_id The same bug_id passed in, just for convenience.

See Also:

bug_tracker::bug::update

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

Testcases:
No testcase defined.

bug_tracker::bug::format_log_title::format_log_title (private)

 bug_tracker::bug::format_log_title::format_log_title case_id object_id \
    action_id entry_id data_arraylist

Parameters:

case_id (required)

object_id (required)

action_id (required)

entry_id (required)

data_arraylist (required)

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

Testcases:
No testcase defined.

bug_tracker::bug::format_log_title::pretty_name (private)

 bug_tracker::bug::format_log_title::pretty_name

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

Testcases:
No testcase defined.

bug_tracker::bug::get (public)

 bug_tracker::bug::get -bug_id bug_id -array array \
    [ -enabled_action_id enabled_action_id ]

Get the fields for a bug

Switches:

-bug_id (required)
-array (required)
-enabled_action_id (optional)

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

Testcases:
No testcase defined.

bug_tracker::bug::get_bug_numbers (public)

 bug_tracker::bug::get_bug_numbers

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

Testcases:
No testcase defined.

bug_tracker::bug::get_component_maintainer::get_assignees (private)

 bug_tracker::bug::get_component_maintainer::get_assignees case_id \
    object_id role_id

Parameters:

case_id (required)

object_id (required)

role_id (required)

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

Testcases:
No testcase defined.

bug_tracker::bug::get_component_maintainer::pretty_name (private)

 bug_tracker::bug::get_component_maintainer::pretty_name

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

Testcases:
No testcase defined.

bug_tracker::bug::get_instance_workflow_id (public)

 bug_tracker::bug::get_instance_workflow_id [ -package_id package_id ]

Return the workflow_id for the package (not instance) workflow

Switches:

-package_id (optional)

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

Testcases:
No testcase defined.

bug_tracker::bug::get_list (public)

 bug_tracker::bug::get_list [ -ulevel ulevel ] \
    [ -package_id package_id ] [ -user_id user_id ] \
    [ -no_bulk_actions ]

Switches:

-ulevel (optional, defaults to "1")
-package_id (optional)
-user_id (optional)
-no_bulk_actions (optional, boolean)

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

Testcases:
No testcase defined.

bug_tracker::bug::get_multirow (public)

 bug_tracker::bug::get_multirow [ -package_id package_id ] \
    [ -user_id user_id ] [ -truncate_len truncate_len ] \
    [ -query_name query_name ]

Switches:

-package_id (optional)
-user_id (optional)
-truncate_len (optional)
-query_name (optional, defaults to "bugs")

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

Testcases:
No testcase defined.

bug_tracker::bug::get_package_workflow_id (public)

 bug_tracker::bug::get_package_workflow_id

Return the workflow_id for the package (not instance) workflow

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

Testcases:
No testcase defined.

bug_tracker::bug::get_project_maintainer::get_assignees (private)

 bug_tracker::bug::get_project_maintainer::get_assignees case_id \
    object_id role_id

Parameters:

case_id (required)

object_id (required)

role_id (required)

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

Testcases:
No testcase defined.

bug_tracker::bug::get_project_maintainer::pretty_name (private)

 bug_tracker::bug::get_project_maintainer::pretty_name

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

Testcases:
No testcase defined.

bug_tracker::bug::get_query (public)

 bug_tracker::bug::get_query [ -query_name query_name ]

Switches:

-query_name (optional, defaults to "bugs")

Returns:
The query

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

Testcases:
No testcase defined.

bug_tracker::bug::get_watch_link (public)

 bug_tracker::bug::get_watch_link -bug_id bug_id

Get link for watching a bug.

Switches:

-bug_id (required)

Returns:
3-tuple of url, label and title.

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

Testcases:
No testcase defined.

bug_tracker::bug::insert (public)

 bug_tracker::bug::insert -bug_id bug_id -package_id package_id \
    -component_id component_id -found_in_version found_in_version \
    -summary summary -description description -desc_format desc_format \
    [ -user_agent user_agent ] [ -user_id user_id ] \
    [ -ip_address ip_address ] [ -item_subtype item_subtype ] \
    [ -content_type content_type ] \
    [ -fix_for_version fix_for_version ] [ -assign_to assign_to ]

Inserts a new bug into the content repository. You probably don't want to run this yourself - to create a new bug, use bug_tracker::bug::new and let it do the hard work for you.

Switches:

-bug_id (required)
-package_id (required)
-component_id (required)
-found_in_version (required)
-summary (required)
-description (required)
-desc_format (required)
-user_agent (optional)
-user_id (optional)
-ip_address (optional)
-item_subtype (optional, defaults to "bt_bug")
-content_type (optional, defaults to "bt_bug_revision")
-fix_for_version (optional)
-assign_to (optional)

Returns:
bug_id The same bug_id passed in, just for convenience.

See Also:

bug_tracker::bug::new

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

Testcases:
No testcase defined.

bug_tracker::bug::instance_workflow_create (private)

 bug_tracker::bug::instance_workflow_create -package_id package_id \
    [ -workflow_id workflow_id ]

Creates a clone of the given workflow for a specific package instance, or reassign an existing clone if it already exists.

Switches:

-package_id (required)
-workflow_id (optional)

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

Testcases:
No testcase defined.

bug_tracker::bug::instance_workflow_delete (private)

 bug_tracker::bug::instance_workflow_delete -package_id package_id

Deletes the instance workflow

Switches:

-package_id (required)

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

Testcases:
No testcase defined.

bug_tracker::bug::new (public)

 bug_tracker::bug::new -bug_id bug_id -package_id package_id \
    -component_id component_id -found_in_version found_in_version \
    -summary summary -description description -desc_format desc_format \
    [ -user_agent user_agent ] [ -user_id user_id ] \
    [ -ip_address ip_address ] [ -item_subtype item_subtype ] \
    [ -content_type content_type ] [ -keyword_ids keyword_ids ] \
    [ -fix_for_version fix_for_version ] [ -assign_to assign_to ]

Create a new bug, then send out notifications, starts workflow, etc. Calls bug_tracker::bug::insert.

Switches:

-bug_id (required)
-package_id (required)
-component_id (required)
-found_in_version (required)
-summary (required)
-description (required)
-desc_format (required)
-user_agent (optional)
-user_id (optional)
-ip_address (optional)
-item_subtype (optional, defaults to "bt_bug")
-content_type (optional, defaults to "bt_bug_revision")
-keyword_ids (optional)
-fix_for_version (optional)
-assign_to (optional)

Returns:
bug_id The same bug_id passed in, just for convenience.

See Also:

bug_tracker::bug::insert.

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

Testcases:
No testcase defined.

bug_tracker::bug::notification_info::get_notification_info (private)

 bug_tracker::bug::notification_info::get_notification_info case_id \
    object_id

Parameters:

case_id (required)

object_id (required)

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

Testcases:
No testcase defined.

bug_tracker::bug::notification_info::pretty_name (private)

 bug_tracker::bug::notification_info::pretty_name

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

Testcases:
No testcase defined.

bug_tracker::bug::object_type (public)

 bug_tracker::bug::object_type

Get the short name of the workflow for bugs

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

Testcases:
No testcase defined.

bug_tracker::bug::update (public)

 bug_tracker::bug::update -bug_id bug_id [ -user_id user_id ] \
    [ -creation_ip creation_ip ] -array array

Update a bug in the DB. Usually, you'll want to use bug_tracker::bug::edit because that one sends out notifications, etc.

Switches:

-bug_id (required)
-user_id (optional)
-creation_ip (optional)
-array (required)

Returns:
bug_id The same bug_id passed in, just for convenience.

See Also:

bug_tracker::bug::edit

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

Testcases:
No testcase defined.

bug_tracker::bug::workflow_create (private)

 bug_tracker::bug::workflow_create

Create the 'bug' workflow for bug-tracker

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

Testcases:
No testcase defined.

bug_tracker::bug::workflow_delete (private)

 bug_tracker::bug::workflow_delete

Delete the 'bug' workflow for bug-tracker

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

Testcases:
No testcase defined.

bug_tracker::bug::workflow_short_name (public)

 bug_tracker::bug::workflow_short_name

Get the short name of the workflow for bugs

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

Testcases:
No testcase defined.

[ show source ]