%3 ::nx::Object ::nx::Object __default_accessor __default_method_call_protection __object_configureparameter __resolve_method_path contains copy delete object method delete object property delete object variable destroy_on_cleanup info info info lookup parameters info lookup slots info lookup syntax info lookup variables info object method args info object method body info object method callprotection info object method debug info object method definition info object method definitionhandle info object method deprecated info object method exists info object method handle info object method origin info object method parameters info object method registrationhandle info object method returns info object method submethods info object method syntax info object method type info object slots info object variables info variable definition info variable name info variable parameter move object alias object forward object method object property object variable private protected public qn require namespace require object method require private object method require protected object method require public object method serialize ::acs::SiteNode ::acs::SiteNode flush_cache get get_children get_node_id get_package_url get_url get_urls_from_object_id get_urls_from_package_key has_children properties ::acs::SiteNode->::nx::Object

Class ::acs::SiteNode

::acs::SiteNode[i] 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[i]
  • superclass: ::nx::Object[i]

Methods (to be applied on instances)

  • flush_cache (scripted, public)

     <instance of acs::SiteNode[i]> 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[i]> 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[i]> 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_node_id (forward)

  • get_package_url (scripted, public)

     <instance of acs::SiteNode[i]> 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_url (forward)

  • get_urls_from_object_id (scripted, public)

     <instance of acs::SiteNode[i]> 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[i]> 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.