::xo::db::Class ::xo::db::sql::workflow

Methods: All Methods Documented Methods Hide Methods
Source: Display Source Hide Source
Variables: Show Variables Hide Variables

Class ::xo::db::sql::workflow_case

::xo::db::sql::workflow_case create ...
Class Relations

class: ::xo::db::Class

superclass: ::xotcl::Object

Methods (to be applied on the object)
add_manual_assignment (scripted, public)
 xo::db::sql::workflow_case add_manual_assignment [ -dbn dbn ] \
    -case_id case_id  -role_key role_key  -party_id party_id 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-role_key (required)
-party_id (required)

Testcases:
No testcase defined.
add_task_assignment (scripted, public)
 xo::db::sql::workflow_case add_task_assignment [ -dbn dbn ] \
    -task_id task_id  -party_id party_id  -permanent_p permanent_p 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-party_id (required)
-permanent_p (required)

Testcases:
No testcase defined.
add_token (scripted, public)
 xo::db::sql::workflow_case add_token [ -dbn dbn ] -case_id case_id  \
    -place_key place_key  -journal_id journal_id 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-place_key (required)
-journal_id (required)

Testcases:
No testcase defined.
begin_task_action (scripted, public)
 xo::db::sql::workflow_case begin_task_action [ -dbn dbn ] \
    -task_id task_id  -action action  -action_ip action_ip  \
    -user_id user_id  [ -msg msg ]
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-action (required)
-action_ip (required)
-user_id (required)
-msg (optional)

Testcases:
No testcase defined.
cancel (scripted, public)
 xo::db::sql::workflow_case cancel [ -dbn dbn ] -case_id case_id  \
    [ -user_id user_id ] [ -ip_address ip_address ] [ -msg msg ]
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-user_id (optional)
-ip_address (optional)
-msg (optional)

Testcases:
No testcase defined.
cancel_task (scripted, public)
 xo::db::sql::workflow_case cancel_task [ -dbn dbn ] -task_id task_id  \
    -journal_id journal_id 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-journal_id (required)

Testcases:
No testcase defined.
clear_manual_assignments (scripted, public)
 xo::db::sql::workflow_case clear_manual_assignments [ -dbn dbn ] \
    -case_id case_id  -role_key role_key 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-role_key (required)

Testcases:
No testcase defined.
clear_task_assignments (scripted, public)
 xo::db::sql::workflow_case clear_task_assignments [ -dbn dbn ] \
    -task_id task_id  -permanent_p permanent_p 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-permanent_p (required)

Testcases:
No testcase defined.
consume_token (scripted, public)
 xo::db::sql::workflow_case consume_token [ -dbn dbn ] \
    -case_id case_id  -place_key place_key  -journal_id journal_id  \
    [ -task_id task_id ]
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-place_key (required)
-journal_id (required)
-task_id (optional)

Testcases:
No testcase defined.
delete (scripted, public)
 xo::db::sql::workflow_case delete [ -dbn dbn ] -case_id case_id 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)

Testcases:
No testcase defined.
enable_transitions (scripted, public)
 xo::db::sql::workflow_case enable_transitions [ -dbn dbn ] \
    -case_id case_id 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)

Testcases:
No testcase defined.
end_task_action (scripted, public)
 xo::db::sql::workflow_case end_task_action [ -dbn dbn ] \
    -journal_id journal_id  -action action  -task_id task_id 
Automatically generated method

Switches:

-dbn (optional)
-journal_id (required)
-action (required)
-task_id (required)

Testcases:
No testcase defined.
ensure_task_in_state (scripted, public)
 xo::db::sql::workflow_case ensure_task_in_state [ -dbn dbn ] \
    -task_id task_id  -state state 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-state (required)

Testcases:
No testcase defined.
evaluate_guard (scripted, public)
 xo::db::sql::workflow_case evaluate_guard [ -dbn dbn ] \
    -callback callback  -custom_arg custom_arg  -case_id case_id  \
    -workflow_key workflow_key  -transition_key transition_key  \
    -place_key place_key  -direction direction 
Automatically generated method

Switches:

-dbn (optional)
-callback (required)
-custom_arg (required)
-case_id (required)
-workflow_key (required)
-transition_key (required)
-place_key (required)
-direction (required)

Testcases:
No testcase defined.
execute_hold_timeout_callback (scripted, public)
 xo::db::sql::workflow_case execute_hold_timeout_callback [ -dbn dbn ] \
    -callback callback  -custom_arg custom_arg  -case_id case_id  \
    -transition_key transition_key 
Automatically generated method

Switches:

-dbn (optional)
-callback (required)
-custom_arg (required)
-case_id (required)
-transition_key (required)

Testcases:
No testcase defined.
execute_time_callback (scripted, public)
 xo::db::sql::workflow_case execute_time_callback [ -dbn dbn ] \
    -callback callback  -custom_arg custom_arg  -case_id case_id  \
    -transition_key transition_key 
Automatically generated method

Switches:

-dbn (optional)
-callback (required)
-custom_arg (required)
-case_id (required)
-transition_key (required)

Testcases:
No testcase defined.
execute_transition_callback (scripted, public)
 xo::db::sql::workflow_case execute_transition_callback [ -dbn dbn ] \
    -callback callback  -custom_arg custom_arg  -case_id case_id  \
    -transition_key transition_key 
Automatically generated method

Switches:

-dbn (optional)
-callback (required)
-custom_arg (required)
-case_id (required)
-transition_key (required)

Testcases:
No testcase defined.
execute_unassigned_callback (scripted, public)
 xo::db::sql::workflow_case execute_unassigned_callback [ -dbn dbn ] \
    -callback callback  -task_id task_id  -custom_arg custom_arg 
Automatically generated method

Switches:

-dbn (optional)
-callback (required)
-task_id (required)
-custom_arg (required)

Testcases:
No testcase defined.
finish_task (scripted, public)
 xo::db::sql::workflow_case finish_task [ -dbn dbn ] -task_id task_id  \
    -journal_id journal_id 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-journal_id (required)

Testcases:
No testcase defined.
finished_p (scripted, public)
 xo::db::sql::workflow_case finished_p [ -dbn dbn ] -case_id case_id  \
    -journal_id journal_id 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-journal_id (required)

Testcases:
No testcase defined.
fire_message_transition (scripted, public)
 xo::db::sql::workflow_case fire_message_transition [ -dbn dbn ] \
    -task_id task_id 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)

Testcases:
No testcase defined.
fire_transition_internal (scripted, public)
 xo::db::sql::workflow_case fire_transition_internal [ -dbn dbn ] \
    -task_id task_id  -journal_id journal_id 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-journal_id (required)

Testcases:
No testcase defined.
get_attribute_value (scripted, public)
 xo::db::sql::workflow_case get_attribute_value [ -dbn dbn ] \
    -case_id case_id  -attribute_name attribute_name 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-attribute_name (required)

Testcases:
No testcase defined.
get_task_deadline (scripted, public)
 xo::db::sql::workflow_case get_task_deadline [ -dbn dbn ] \
    -callback callback  -custom_arg custom_arg  \
    -attribute_name attribute_name  -case_id case_id  \
    -transition_key transition_key 
Automatically generated method

Switches:

-dbn (optional)
-callback (required)
-custom_arg (required)
-attribute_name (required)
-case_id (required)
-transition_key (required)

Testcases:
No testcase defined.
get_task_id (scripted, public)
 xo::db::sql::workflow_case get_task_id [ -dbn dbn ] -case_id case_id  \
    -transition_key transition_key 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-transition_key (required)

Testcases:
No testcase defined.
lock_token (scripted, public)
 xo::db::sql::workflow_case lock_token [ -dbn dbn ] -case_id case_id  \
    -place_key place_key  -journal_id journal_id  -task_id task_id 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-place_key (required)
-journal_id (required)
-task_id (required)

Testcases:
No testcase defined.
new (scripted, public)
 xo::db::sql::workflow_case new [ -dbn dbn ] [ -case_id case_id ] \
    -workflow_key workflow_key  [ -context_key context_key ] \
    -object_id object_id  [ -creation_date creation_date ] \
    [ -creation_user creation_user ] [ -creation_ip creation_ip ] \
    [ -childof childof ]
Automatically generated method

Switches:

-dbn (optional)
-case_id (optional)
-workflow_key (required)
-context_key (optional)
-object_id (required)
-creation_date (optional, defaults to "now()")
-creation_user (optional)
-creation_ip (optional)
-childof (optional)

Testcases:
No testcase defined.
notify_assignee (scripted, public)
 xo::db::sql::workflow_case notify_assignee [ -dbn dbn ] \
    -task_id task_id  -user_id user_id  -callback callback  \
    -custom_arg custom_arg 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-user_id (required)
-callback (required)
-custom_arg (required)

Testcases:
No testcase defined.
release_token (scripted, public)
 xo::db::sql::workflow_case release_token [ -dbn dbn ] \
    -task_id task_id  -journal_id journal_id 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-journal_id (required)

Testcases:
No testcase defined.
remove_case_deadline (scripted, public)
 xo::db::sql::workflow_case remove_case_deadline [ -dbn dbn ] \
    -case_id case_id  -transition_key transition_key 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-transition_key (required)

Testcases:
No testcase defined.
remove_manual_assignment (scripted, public)
 xo::db::sql::workflow_case remove_manual_assignment [ -dbn dbn ] \
    -case_id case_id  -role_key role_key  -party_id party_id 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-role_key (required)
-party_id (required)

Testcases:
No testcase defined.
remove_task_assignment (scripted, public)
 xo::db::sql::workflow_case remove_task_assignment [ -dbn dbn ] \
    -task_id task_id  -party_id party_id  -permanent_p permanent_p 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-party_id (required)
-permanent_p (required)

Testcases:
No testcase defined.
resume (scripted, public)
 xo::db::sql::workflow_case resume [ -dbn dbn ] -case_id case_id  \
    [ -user_id user_id ] [ -ip_address ip_address ] [ -msg msg ]
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-user_id (optional)
-ip_address (optional)
-msg (optional)

Testcases:
No testcase defined.
set_attribute_value (scripted, public)
 xo::db::sql::workflow_case set_attribute_value [ -dbn dbn ] \
    -journal_id journal_id  -attribute_name attribute_name  \
    -value value 
Automatically generated method

Switches:

-dbn (optional)
-journal_id (required)
-attribute_name (required)
-value (required)

Testcases:
No testcase defined.
set_case_deadline (scripted, public)
 xo::db::sql::workflow_case set_case_deadline [ -dbn dbn ] \
    -case_id case_id  -transition_key transition_key  \
    -deadline deadline 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-transition_key (required)
-deadline (required)

Testcases:
No testcase defined.
set_task_assignments (scripted, public)
 xo::db::sql::workflow_case set_task_assignments [ -dbn dbn ] \
    -task_id task_id  -callback callback  -custom_arg custom_arg 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-callback (required)
-custom_arg (required)

Testcases:
No testcase defined.
start_case (scripted, public)
 xo::db::sql::workflow_case start_case [ -dbn dbn ] -case_id case_id  \
    [ -creation_user creation_user ] [ -creation_ip creation_ip ] \
    [ -msg msg ]
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-creation_user (optional)
-creation_ip (optional)
-msg (optional)

Testcases:
No testcase defined.
start_task (scripted, public)
 xo::db::sql::workflow_case start_task [ -dbn dbn ] -task_id task_id  \
    -user_id user_id  -journal_id journal_id 
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-user_id (required)
-journal_id (required)

Testcases:
No testcase defined.
suspend (scripted, public)
 xo::db::sql::workflow_case suspend [ -dbn dbn ] -case_id case_id  \
    [ -user_id user_id ] [ -ip_address ip_address ] [ -msg msg ]
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-user_id (optional)
-ip_address (optional)
-msg (optional)

Testcases:
No testcase defined.
sweep_automatic_transitions (scripted, public)
 xo::db::sql::workflow_case sweep_automatic_transitions [ -dbn dbn ] \
    -case_id case_id  -journal_id journal_id 
Automatically generated method

Switches:

-dbn (optional)
-case_id (required)
-journal_id (required)

Testcases:
No testcase defined.
sweep_hold_timeout (scripted, public)
 xo::db::sql::workflow_case sweep_hold_timeout [ -dbn dbn ]
Automatically generated method

Switches:

-dbn (optional)

Testcases:
No testcase defined.
sweep_timed_transitions (scripted, public)
 xo::db::sql::workflow_case sweep_timed_transitions [ -dbn dbn ]
Automatically generated method

Switches:

-dbn (optional)

Testcases:
No testcase defined.
task_action (scripted, public)
 xo::db::sql::workflow_case task_action [ -dbn dbn ] -task_id task_id  \
    -action action  -action_ip action_ip  -user_id user_id  \
    [ -msg msg ]
Automatically generated method

Switches:

-dbn (optional)
-task_id (required)
-action (required)
-action_ip (required)
-user_id (required)
-msg (optional)

Testcases:
No testcase defined.

Methods: All Methods Documented Methods Hide Methods
Source: Display Source Hide Source
Variables: Show Variables Hide Variables

Class ::xo::db::sql::workflow_case

Class Relations

Methods (to be applied on the object)

add_manual_assignment (scripted, public)

add_task_assignment (scripted, public)

add_token (scripted, public)

begin_task_action (scripted, public)

cancel (scripted, public)

cancel_task (scripted, public)

clear_manual_assignments (scripted, public)

clear_task_assignments (scripted, public)

consume_token (scripted, public)

delete (scripted, public)

enable_transitions (scripted, public)

end_task_action (scripted, public)

ensure_task_in_state (scripted, public)

evaluate_guard (scripted, public)

execute_hold_timeout_callback (scripted, public)

execute_time_callback (scripted, public)

execute_transition_callback (scripted, public)

execute_unassigned_callback (scripted, public)

finish_task (scripted, public)

finished_p (scripted, public)

fire_message_transition (scripted, public)

fire_transition_internal (scripted, public)

get_attribute_value (scripted, public)

get_task_deadline (scripted, public)

get_task_id (scripted, public)

lock_token (scripted, public)

new (scripted, public)

notify_assignee (scripted, public)

release_token (scripted, public)

remove_case_deadline (scripted, public)

remove_manual_assignment (scripted, public)

remove_task_assignment (scripted, public)

resume (scripted, public)

set_attribute_value (scripted, public)

set_case_deadline (scripted, public)

set_task_assignments (scripted, public)

start_case (scripted, public)

start_task (scripted, public)

suspend (scripted, public)

sweep_automatic_transitions (scripted, public)

sweep_hold_timeout (scripted, public)

sweep_timed_transitions (scripted, public)

task_action (scripted, public)