::xotcl::Class ::xowf::WorkflowPage

Begin main content

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

Class ::xowf::WorkflowPage

::xowf::WorkflowPage create ...
Defined in
Class Relations

class: ::xotcl::Class

superclass: ::xotcl::Object

Methods (to be applied on instances)
answer_is_correct (scripted, public)
 <instance of xowf::WorkflowPage> answer_is_correct
Check, if answer is correct based on "answer" and "correct_when" attributes of form fields and provided user input.

Testcases:
No testcase defined.
call_action (scripted, public)
 <instance of xowf::WorkflowPage> 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)

Testcases:
No testcase defined.
call_action_foreach (scripted, public)
 <instance of xowf::WorkflowPage> 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 (required)

Testcases:
No testcase defined.
childpage (scripted, public)
 <instance of xowf::WorkflowPage> 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

Testcases:
create_test_items
footer (scripted, public)
 <instance of xowf::WorkflowPage> 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.

Testcases:
create_workflow_with_instance
get_action_obj (scripted, public)
 <instance of xowf::WorkflowPage> 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)

Testcases:
create_workflow_with_instance
get_revision_sets (scripted, public)
 <instance of xowf::WorkflowPage> 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)

Testcases:
create_test_items
is_wf (scripted, public)
 <instance of xowf::WorkflowPage> is_wf
Check, if the current page is a workflow page (page, defining a workflow)

Testcases:
create_test_items, create_workflow_with_instance
is_wf_instance (scripted, public)
 <instance of xowf::WorkflowPage> is_wf_instance
Check, if the current page is a workflow instance (page, referring to a workflow)

Testcases:
create_test_items, create_workflow_with_instance
post_process_dom_tree (scripted, public)
 <instance of xowf::WorkflowPage> 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 (required)

dom_root (required)

form_fields (required)

Testcases:
create_workflow_with_instance
post_process_form_fields (scripted, public)
 <instance of xowf::WorkflowPage> post_process_form_fields \
    form_fields
Propagate the feedback mode setting of this workflow page to the supplied formfields.

Parameters:

form_fields (required)

Testcases:
create_workflow_with_instance
render_form_action_buttons (scripted, public)
 <instance of xowf::WorkflowPage> render_form_action_buttons \
    [ -formfieldButtonClass formfieldButtonClass ] \
    [ -CSSclass CSSclass ]
Render the defined actions in the current state with submit buttons

Switches:

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

Testcases:
create_workflow_with_instance
render_form_action_buttons_widgets (scripted, public)
 <instance of xowf::WorkflowPage> 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 (required)

Testcases:
create_workflow_with_instance
render_icon (scripted, public)
 <instance of xowf::WorkflowPage> render_icon
Provide an icon or text for describing the kind of application.

Testcases:
create_workflow_with_instance
render_thumbnails (scripted, public)
 <instance of xowf::WorkflowPage> render_thumbnails upload_info
Renderer of the thumbnail file(s)

Parameters:

upload_info (required)
dict containing the "file_object" and "file_name"

Returns:
HTML content

Testcases:
No testcase defined.
schedule_action (scripted, public)
 <instance of xowf::WorkflowPage> 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)

Testcases:
No testcase defined.
schedule_job (scripted, public)
 <instance of xowf::WorkflowPage> 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 (required)

Testcases:
No testcase defined.
solution_set (scripted, public)
 <instance of xowf::WorkflowPage> solution_set
Compute solution set in form of attribute=value pairs based on "answer" attribute of form fields.

Testcases:
No testcase defined.
stats_record_count (scripted, public)
 <instance of xowf::WorkflowPage> stats_record_count name
Record that the specified question was used.

Parameters:

name (required)

Testcases:
create_test_items
stats_record_detail (scripted, public)
 <instance of xowf::WorkflowPage> 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 (optional, boolean)

Testcases:
create_test_items
wf_context (scripted, public)
 <instance of xowf::WorkflowPage> 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)

Testcases:
create_workflow_with_instance
www-edit (scripted, public)
 <instance of xowf::WorkflowPage> www-edit args [ args... ]
Hook for editing workflow pages

Parameters:

args (required)

Testcases:
create_workflow_with_instance
www-view (scripted, public)
 <instance of xowf::WorkflowPage> 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)

Testcases:
create_test_items, create_workflow_with_instance
Variables
::xowf::WorkflowPage set __default_metaclass ::xotcl::Class
::xowf::WorkflowPage set __default_superclass ::xotcl::Object

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