Package bscw :: Package api :: Module ap_lst_entries

Module ap_lst_entries


Lists container entries (used by portal widgets)

   If sort is None: default sort method (user defined prefs) is used
   If period is None: no period is applied
   If flter is None: no filter is applied
   If attributes is empty: default attributes are returned, otherwise
   only (available) list attributes are returned;
     - attributes starting with a '+' character are added to the
       returned default attributes, eg. attributes=['+abstract', '+presence']
     - attributes starting with a '-' character are omitted from
       the returned attributes, eg.  attributes=['-summary']
   If maxcount is not 0: return no more than 'maxcount' entries
   If offset is not 0: return items startin from 'offset'
   If modified is not 0:
      return items with last-modified date > 'modified' (UTC timestamp)

   returns list of tasks matching the query


API definition::

 API = (('object_id', 'ASCII string', 1),
        ('sort', 'ASCII string', 0),
        ('period', 'ASCII string', 0),
        ('flter', 'ASCII string', 0),
        ('attributes', 'array', 0, [('item', 'ASCII string', 1)]),
        ('maxcount', 'int', 0),
        ('offset', 'int', 0),
        ('modified', 'double', 0))

(c) OrbiTeam Software, 2009-2012

Version: $Rev: 24413 $

Functions

[hide private]

param_def()
return the parameter definition

return_def()
return the result definition

do_it(request, object_id, sort=None, period=None, flter=None, attributes=[], maxcount=0, offset=0, modified=0)
see above

list_entries(request, obj, sort=None, period=None, flter=None, attr=[], maxcount=0, offset=0, modified=0)

extend_entries(request, entries, period, attr_get, attr_ext, sort)

Variables

[hide private]

log_api = logging.getLogger('api')

ignore_CantCommit = True

class_attr_ext_default = {Calendar: [],}

filter_map = {'contact': 'contacts', 'document': 'documents', ...

__package__ = 'bscw.api'

Variables Details

[hide private]

filter_map

Value:

{'contact': 'contacts',
 'document': 'documents',
 'folder': 'containers',
 'shared': 'shared'}