---

Class ::acs::SiteNode

::acs::SiteNode create ...

This class capsulates access to site-nodes stored in the database. It is written in a style to support the needs of the traditional Tcl-based API.

Author:

Gustaf Neumann

Defined in packages/acs-tcl/tcl/site-nodes-procs.tcl

Class Relations

• class: ::nx::Class
• superclass: ::nx::Object

Methods (to be applied on instances)

• flush_cache (scripted, public)

   <instance of acs::SiteNode> flush_cache -node_id node_id  \
      [ -with_subtree on|off ] [ -url url ]

  This is a stub method to be overloaded by some cache managers.

  Switches:

  -node_id (required)

  -with_subtree (optional, boolean)

  -url (optional)

  Testcases:

  No testcase defined.

• get (scripted, public)

   <instance of acs::SiteNode> get [ -url url ] \
      [ -node_id node_id ]

  Switches:

  -url (optional)

  -node_id (optional)

  Returns:

  a site node from url or site-node with all its context info

  Testcases:

  No testcase defined.

• get_children (scripted, public)

   <instance of acs::SiteNode> get_children -node_id node_id  \
      [ -all ] [ -package_type package_type ] \
      [ -package_key package_key ] [ -filters filters ] \
      [ -element element ]

  Filtering happens here exactly like in the nsv-based version. If should be possible to realize (at least some of the) filtering via the SQL query.

  Switches:

  -node_id (required)

  -all (optional)

  -package_type (optional)

  -package_key (optional)

  -filters (optional)

  -element (optional)

  Testcases:

  No testcase defined.

• get_package_url (scripted, public)

   <instance of acs::SiteNode> get_package_url \
      -package_key package_key 

  Legacy interface: previous implementations of the site-nodes assumed, that there is just one site-node entry available for a package-key. This method returns just the first answer form get_urls_from_package_key

  Switches:

  -package_key (required)

  Testcases:

  No testcase defined.

• get_urls_from_object_id (scripted, public)

   <instance of acs::SiteNode> get_urls_from_object_id \
      -object_id object_id 

  Return a list of URLs for site_nodes that have the given object mounted or the empty list if there are none. The URLs are returned in descending order meaning any children will come before their parents. This ordering is useful when deleting site nodes as we must delete child site nodes before their parents.

  Switches:

  -object_id (required, integer)

  Testcases:

  No testcase defined.

• get_urls_from_package_key (scripted, public)

   <instance of acs::SiteNode> get_urls_from_package_key \
      -package_key package_key 

  Return potentially multiple URLs based on a package key.

  Switches:

  -package_key (required)

  Testcases:

  No testcase defined.

---