---

Class ::xowf::Package

::xowf::Package create ...

Defined in

Class Relations

• class: ::xo::PackageMgr
• superclass: ::xowiki::Package

::xo::PackageMgr create ::xowf::Package \
     -superclass ::xowiki::Package

Methods (to be applied on the object)

• create_new_workflow_page (scripted, public)

   xowf::Package create_new_workflow_page -package_id package_id  \
      -parent_id parent_id  -name name  -title title  \
      [ -instance_attributes instance_attributes ]

  Helper proc for loading workflow prototype page with less effort.

  Switches:

  -package_id (required)

  -parent_id (required)

  -name (required)

  -title (required)

  -instance_attributes (optional)

  Testcases:

  create_new_workflow_page

  #
  # Load Workflow.form
  #
  xo::Package require $package_id
  set item_ref_info [$package_id item_ref -use_site_wide_pages true -default_lang en  -parent_id $parent_id  en:Workflow.form]
  set page_template [dict get $item_ref_info item_id]
  if {$page_template != 0} {
    #
    # Create FormPage
    #
    set p [::xowiki::FormPage new  -name $name  -title $title  -set text {}  -instance_attributes $instance_attributes  -page_template $page_template]
  } else {
    ns_log error "could not load Workflow form, therefore, creation of workflow $name failed as well"
    set p ""
  }
  return $p

Methods (to be applied on instances)

• call (scripted)

  if {[$object istype ::xowiki::FormPage]} {
    if {[$object is_wf_instance]} {
      set ctx [::xowf::Context require $object]
      #:msg "wfi: creating context form object $object = $ctx, chlds=[$ctx info children]"
      #:msg "wfi: o $object has mixins [$object info mixin]"
    } elseif {[$object is_wf]} {
      set ctx [::xowf::Context require $object]
      #:msg "wf: creating context form object $object = $ctx, chlds=[$ctx info children]"
      #:msg "wf: o $object has mixins [$object info mixin]"
    }
  }
  next

• destroy (scripted, public)

   <instance of xowf::Package> destroy

  remove mixin

  Testcases:

  create_test_items, create_workflow_with_instance

  #
  # In general, it is possible, that multiple xowf packages are
  # concurrently active in one thread. We want to remove the mixin
  # only, when the last instance is deleted.
  #
  if {[llength [[self class] allinstances]] == 1} {
    ::xowiki::FormPage instmixin delete ::xowf::WorkflowPage
  }
  next

• initialize (scripted, public)

   <instance of xowf::Package> initialize

  Add mixin ::xowf::WorkflowPage to every FormPage.

  Testcases:

  create_test_items, create_folder_with_page, create_workflow_with_instance

  #
  # This method is called, whenever an xowf package is initialized.
  #
  next
  #:msg "::xowiki::FormPage instmixin add ::xowf::WorkflowPage"
  ::xowiki::FormPage instmixin add ::xowf::WorkflowPage

• insert (scripted)

  set __table_name [[self class] table_name]
  set __id [[self class] id_column]
  set :$__id ${:object_id}
  :log "ID insert in $__table_name, id = $__id = [set :$__id]"
  next
  foreach {__slot_name __slot} [[self class] array get db_slot] {
    if {[info exists :$__slot_name]} {
      set $__slot_name [set :$__slot_name]
      lappend __vars $__slot_name
      lappend __atts [$__slot column_name]
    }
  }
  ::xo::dc dml insert_$__table_name "insert into $__table_name
    ([join $__atts ,]) values (:[join $__vars ,:])"

• package_id (setter)

---