%3 ::xotcl::Object ::xotcl::Object ::xowf::WorkflowPage ::xowf::WorkflowPage answer_is_correct call_action call_action_foreach childpage footer get_action_obj get_revision_sets is_wf is_wf_instance post_process_dom_tree post_process_form_fields render_form_action_buttons render_form_action_buttons_widgets render_icon render_thumbnails schedule_action schedule_job solution_set stats_record_count stats_record_detail wf_context www-edit www-view ::xowf::WorkflowPage->::xotcl::Object

Class ::xowf::WorkflowPage

::xowf::WorkflowPage[i] create ...

Class Relations

  • class: ::xotcl::Class[i]
  • superclass: ::xotcl::Object[i]

Methods (to be applied on instances)

  • answer_is_correct (scripted, public)

     <instance of xowf::WorkflowPage[i]> answer_is_correct

    Check, if answer is correct based on "answer" and "correct_when" attributes of form fields and provided user input.

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

    Testcases:
    No testcase defined.

  • call_action (scripted, public)

     <instance of xowf::WorkflowPage[i]> call_action [ -action action ] \
    [ -attributes attributes ]

    Call the specified action in the current workflow instance. The specified attributes are provided like form_parameters to the action of the workflow.

    Switches:
    -action
    (optional)
    -attributes
    (optional)

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

    Testcases:
    No testcase defined.

  • call_action_foreach (scripted, public)

     <instance of xowf::WorkflowPage[i]> call_action_foreach \
    -action action  [ -attributes attributes ] page_names

    Call the specified action for each of the specified pages denoted by the list of page names

    Switches:
    -action
    (required)
    -attributes
    (optional)
    Parameters:
    page_names

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

    Testcases:
    No testcase defined.

  • childpage (scripted, public)

     <instance of xowf::WorkflowPage[i]> childpage -name name  \
    [ -form form ]

    Return the child page of the current object with the provided name. In case the child object does not exist, create it as an instance of the provided form.

    Switches:
    -name
    (required)
    -form
    (optional)
    Returns:
    page object

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_test_items create_test_items (test xowf) xowf::WorkflowPage instproc childpage xowf::WorkflowPage instproc childpage test_create_test_items->xowf::WorkflowPage instproc childpage

    Testcases:
    create_test_items

  • footer (scripted, public)

     <instance of xowf::WorkflowPage[i]> footer

    Provide a tailored footer for workflow definition pages and workflow instance pages containing controls for instantiating forms or providing links to the workflow definition.

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowf::WorkflowPage instproc footer xowf::WorkflowPage instproc footer test_create_workflow_with_instance->xowf::WorkflowPage instproc footer

    Testcases:
    create_workflow_with_instance

  • get_action_obj (scripted, public)

     <instance of xowf::WorkflowPage[i]> get_action_obj -action action

    Check if the action can be executed in the current state, and if so, return the action_obj.

    Switches:
    -action
    (required)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowf::WorkflowPage instproc get_action_obj xowf::WorkflowPage instproc get_action_obj test_create_workflow_with_instance->xowf::WorkflowPage instproc get_action_obj

    Testcases:
    create_workflow_with_instance

  • get_revision_sets (scripted, public)

     <instance of xowf::WorkflowPage[i]> get_revision_sets \
    [ -with_instance_attributes ]

    Return a list of ns_sets containing revision_id, creation_date, creation_user, creation_ip, and state for the current workflow instance.

    Switches:
    -with_instance_attributes
    (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_test_items create_test_items (test xowf) xowf::WorkflowPage instproc get_revision_sets xowf::WorkflowPage instproc get_revision_sets test_create_test_items->xowf::WorkflowPage instproc get_revision_sets

    Testcases:
    create_test_items

  • is_wf (scripted, public)

     <instance of xowf::WorkflowPage[i]> is_wf

    Check, if the current page is a workflow page (page, defining a workflow)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_test_items create_test_items (test xowf) xowf::WorkflowPage instproc is_wf xowf::WorkflowPage instproc is_wf test_create_test_items->xowf::WorkflowPage instproc is_wf test_create_workflow_with_instance create_workflow_with_instance (test xowf) test_create_workflow_with_instance->xowf::WorkflowPage instproc is_wf

    Testcases:
    create_test_items, create_workflow_with_instance

  • is_wf_instance (scripted, public)

     <instance of xowf::WorkflowPage[i]> is_wf_instance

    Check, if the current page is a workflow instance (page, referring to a workflow)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_test_items create_test_items (test xowf) xowf::WorkflowPage instproc is_wf_instance xowf::WorkflowPage instproc is_wf_instance test_create_test_items->xowf::WorkflowPage instproc is_wf_instance test_create_workflow_with_instance create_workflow_with_instance (test xowf) test_create_workflow_with_instance->xowf::WorkflowPage instproc is_wf_instance

    Testcases:
    create_test_items, create_workflow_with_instance

  • post_process_dom_tree (scripted, public)

     <instance of xowf::WorkflowPage[i]> post_process_dom_tree dom_doc \
    dom_root form_fields

    post-process form in edit mode to provide feedback in feedback mode

    Parameters:
    dom_doc
    dom_root
    form_fields

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowf::WorkflowPage instproc post_process_dom_tree xowf::WorkflowPage instproc post_process_dom_tree test_create_workflow_with_instance->xowf::WorkflowPage instproc post_process_dom_tree html::div html::div xowf::WorkflowPage instproc post_process_dom_tree->html::div html::t html::t xowf::WorkflowPage instproc post_process_dom_tree->html::t

    Testcases:
    create_workflow_with_instance

  • post_process_form_fields (scripted, public)

     <instance of xowf::WorkflowPage[i]> post_process_form_fields \
    form_fields

    Propagate the feedback mode setting of this workflow page to the supplied formfields.

    Parameters:
    form_fields

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowf::WorkflowPage instproc post_process_form_fields xowf::WorkflowPage instproc post_process_form_fields test_create_workflow_with_instance->xowf::WorkflowPage instproc post_process_form_fields

    Testcases:
    create_workflow_with_instance

  • render_form_action_buttons (scripted, public)

     <instance of xowf::WorkflowPage[i]> render_form_action_buttons \
    [ -formfieldButtonClass formfieldButtonClass ] \
    [ -CSSclass CSSclass ]

    Render the defined actions in the current state with submit buttons

    Switches:
    -formfieldButtonClass
    (defaults to "::xowiki::formfield::submit_button") (optional)
    -CSSclass
    (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowf::WorkflowPage instproc render_form_action_buttons xowf::WorkflowPage instproc render_form_action_buttons test_create_workflow_with_instance->xowf::WorkflowPage instproc render_form_action_buttons

    Testcases:
    create_workflow_with_instance

  • render_form_action_buttons_widgets (scripted, public)

     <instance of xowf::WorkflowPage[i]> render_form_action_buttons_widgets \
    [ -CSSclass CSSclass ] buttons

    With the given set of buttons, produce the HTML for the button container and the included inputs.

    Switches:
    -CSSclass
    (optional)
    Parameters:
    buttons

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowf::WorkflowPage instproc render_form_action_buttons_widgets xowf::WorkflowPage instproc render_form_action_buttons_widgets test_create_workflow_with_instance->xowf::WorkflowPage instproc render_form_action_buttons_widgets html::div html::div xowf::WorkflowPage instproc render_form_action_buttons_widgets->html::div

    Testcases:
    create_workflow_with_instance

  • render_icon (scripted, public)

     <instance of xowf::WorkflowPage[i]> render_icon

    Provide an icon or text for describing the kind of application.

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowf::WorkflowPage instproc render_icon xowf::WorkflowPage instproc render_icon test_create_workflow_with_instance->xowf::WorkflowPage instproc render_icon

    Testcases:
    create_workflow_with_instance

  • render_thumbnails (scripted, public)

     <instance of xowf::WorkflowPage[i]> render_thumbnails upload_info

    Renderer of the thumbnail file(s)

    Parameters:
    upload_info - dict containing the "file_object" and "file_name"
    Returns:
    HTML content

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

    Testcases:
    No testcase defined.

  • schedule_action (scripted, public)

     <instance of xowf::WorkflowPage[i]> schedule_action -time time  \
    [ -party_id party_id ] -action action  [ -attributes attributes ]

    Schedule the specified action for the current workflow instance at the given time. The specified attributes are provided like form_parameters to the action of the workflow.

    Switches:
    -time
    (required)
    time when the atjob should be executed
    -party_id
    (optional)
    party_id for the user executing the atjob
    -action
    (required)
    workflow action to be executed
    -attributes
    (optional)
    arguments provided to the workflow action (attribute value pairs)

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

    Testcases:
    No testcase defined.

  • schedule_job (scripted, public)

     <instance of xowf::WorkflowPage[i]> schedule_job -time time  \
    [ -party_id party_id ] cmd

    Schedule the specified Tcl command for the current package instance at the given time.

    Switches:
    -time
    (required)
    -party_id
    (optional)
    Parameters:
    cmd

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

    Testcases:
    No testcase defined.

  • solution_set (scripted, public)

     <instance of xowf::WorkflowPage[i]> solution_set

    Compute solution set in form of attribute=value pairs based on "answer" attribute of form fields.

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

    Testcases:
    No testcase defined.

  • stats_record_count (scripted, public)

     <instance of xowf::WorkflowPage[i]> stats_record_count name

    Record that the specified question was used.

    Parameters:
    name

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_test_items create_test_items (test xowf) xowf::WorkflowPage instproc stats_record_count xowf::WorkflowPage instproc stats_record_count test_create_test_items->xowf::WorkflowPage instproc stats_record_count

    Testcases:
    create_test_items

  • stats_record_detail (scripted, public)

     <instance of xowf::WorkflowPage[i]> stats_record_detail \
    [ -label label ] [ -value value ] [ -name name ] \
    [ -correctly_answered on|off ]

    Record the stat detail of the question.

    Switches:
    -label
    (optional)
    -value
    (optional)
    -name
    (optional)
    -correctly_answered
    (boolean) (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_test_items create_test_items (test xowf) xowf::WorkflowPage instproc stats_record_detail xowf::WorkflowPage instproc stats_record_detail test_create_test_items->xowf::WorkflowPage instproc stats_record_detail

    Testcases:
    create_test_items

  • wf_context (scripted, public)

     <instance of xowf::WorkflowPage[i]> wf_context [ ctx ]

    Return for a workflow page the workflow context object. The same function can be used as well for setting the workflow context at the first places (e.g. on initialization of the wf-context).

    Parameters:
    ctx (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowf::WorkflowPage instproc wf_context xowf::WorkflowPage instproc wf_context test_create_workflow_with_instance->xowf::WorkflowPage instproc wf_context

    Testcases:
    create_workflow_with_instance

  • www-edit (scripted, public)

     <instance of xowf::WorkflowPage[i]> www-edit args [ args... ]

    Hook for editing workflow pages

    Parameters:
    args

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test xowf) xowf::WorkflowPage instproc www-edit xowf::WorkflowPage instproc www-edit test_create_workflow_with_instance->xowf::WorkflowPage instproc www-edit

    Testcases:
    create_workflow_with_instance

  • www-view (scripted, public)

     <instance of xowf::WorkflowPage[i]> www-view [ content ]

    Provide additional view modes: - edit: instead of viewing a page, it is opened in edit mode - view_user_input: show user the provided input - view_user_input_with_feedback: show user the provided input with feedback

    Parameters:
    content (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_test_items create_test_items (test xowf) xowf::WorkflowPage instproc www-view xowf::WorkflowPage instproc www-view test_create_test_items->xowf::WorkflowPage instproc www-view test_create_workflow_with_instance create_workflow_with_instance (test xowf) test_create_workflow_with_instance->xowf::WorkflowPage instproc www-view

    Testcases:
    create_test_items, create_workflow_with_instance