Package bscw :: Package api :: Module ap_chrole
[hide private]

Module ap_chrole

Change roles of members or list all or assigned roles. See change_roles() for a description.

API definition:

API = (('object_id', 'ASCII string', 1),
       ('roles', 'array', 0, [('name_member', 'array', 1, [('pair', 'ASCII string', 0)])]),
       ('all', 'boolean', 0))

(c) Fraunhofer FIT, 2002-2208


Version: $Rev: 20112 $

Functions [hide private]
 
param_def()
return the parameter definition
 
do_it(request, object_id, roles=[], all=False)
see below
list
change_roles(request, object, roles=[], all=False)
Change roles of object members or list all or assigned roles.
Variables [hide private]
  __package__ = None
Function Details [hide private]

change_roles(request, object, roles=[], all=False)

 

Change roles of object members or list all or assigned roles.

Parameters:
  • object (str) - ID of target object
  • roles (list) - roles is a list of (role_name, member_name) pairs. If roles is empty ([]) or omitted, nothing is changed and all assigned roles are returned.
  • all (bool) - if all is True, a list of all roles is returned.
Returns: list
  • if all is False or omitted (default), a list of (role_name, member_name) pairs of all assigned roles is returned.
  • if all is True, a list of all defined roles is returned.