---

::xotcl::Class ::xo::Policy

Class Hierarchy of ::xo::Policy

• ::xotcl::Object

  Meta-class:

  ::xotcl::Class

  Methods for instances:

  __api_make_doc, __api_make_forward_doc, __timediff, abstract, ad_doc, ad_forward, ad_proc, append^C, array^C, asHTML, autoname^C, check, class^C, cleanup^C, configure^C, contains^C, copy^C, db_0or1row^C, db_1row^C, debug, defaultmethod^C, destroy^C, destroy_on_cleanup, ds, eval^C, exists^C, extractConfigureArg, filter^C, filterguard^C, filtersearch, forward, hasclass, incr^C, info^C, init, instvar^C, invar^C, isclass, ismetaclass, ismixin, isobject, istype, lappend^C, log, method, mixin^C, mixinguard^C, move^C, msg, noinit^C, objectparameter, parametercmd^C, proc, procsearch, qn, requireNamespace^C, residualargs^C, self, serialize, set^C, set_instance_vars_defaults, show-object, subst^C, trace^C, unknown, unset^C, uplevel^C, upvar^C, volatile^C, vwait

  Methods to be applied on the class (in addition to the methods provided by the meta-class):

  getExitHandler, setExitHandler, unsetExitHandler

• ::xo::Policy

  Meta-class:

  ::xotcl::Class

  Methods for instances:

  check_permissions, check_privilege, defined_methods, enforce_permissions, get_permission, get_privilege

  Methods to be applied on the class:

  Methods provided by the meta-class

Class Relations

• superclass: ::xotcl::Object
• subclass: ::xowiki::Policy

Methods

• instproc check_permissions (public)

  <instance of ::xo::Policy> check_permissions \
      [ -user_id user_id ] [ -package_id package_id ] [ -link link ] \
      object method

  This method checks whether the current user is allowed or not to invoke a method based on the given policy. This method is purely checking and does not force logins or other side effects. It can be safely used for example to check whether links should be shown or not.

  Switches:

  -user_id (optional)

  -package_id (optional)

  -link (optional)

  Parameters:

  object
  method
  

  Returns:

  0 or 1

  
  See Also:

  • enforce_permissions

• instproc check_privilege

• instproc defined_methods

• instproc enforce_permissions (public)

  <instance of ::xo::Policy> enforce_permissions \
      [ -user_id user_id ] [ -package_id package_id ] object method

  This method checks whether the current user is allowed or not to invoke a method based on the given policy and forces logins if required.

  Switches:

  -user_id (optional)

  -package_id (optional)

  Parameters:

  object
  method
  

  Returns:

  0 or 1

  
  See Also:

  • check_permissions

• instproc get_permission

• instproc get_privilege

Variables

::xo::Policy set __default_metaclass ::xotcl::Class
::xo::Policy set __default_superclass ::xotcl::Object

---