Package Products :: Package Zuul :: Package routers :: Module properties :: Class PropertiesRouter
[hide private]
[frames] | no frames]

Class PropertiesRouter

source code

ZenUtils.Ext.DirectRouter --+
                            |
                           PropertiesRouter

Instance Methods [hide private]
 
_getFacade(self) source code
 
_filterData(self, params, data) source code
 
_sortData(self, sort, data, dir) source code
 
getZenProperties(self, uid, start=0, params="{}", limit=None, sort=None, page=None, dir='ASC')
Returns the definition and values of all the zen properties for this context
source code
Dictionary
getZenProperty(self, uid, zProperty)
Returns information about a zproperty for a given context, including its value
source code
 
getCustomProperties(self, uid, start=0, params="{}", limit=None, sort=None, page=None, dir='ASC')
Returns the definition and values of all the zen properties for this context
source code
 
addCustomProperty(self, id, value, label, uid, type)
adds a new property to the / of the tree
source code
 
setZenProperty(self, uid, zProperty, value=None)
Sets the zProperty value.
source code
 
deleteZenProperty(self, uid, zProperty)
Removes the local instance of the each property in properties.
source code
Method Details [hide private]

_filterData(self, params, data)

source code 
Parameters:
  • params - params passed to the caller and used here for filtering
  • data - data to be filtered and returned

_sortData(self, sort, data, dir)

source code 
Parameters:
  • data - data to be sorted and returned

getZenProperties(self, uid, start=0, params="{}", limit=None, sort=None, page=None, dir='ASC')

source code 

Returns the definition and values of all the zen properties for this context

Parameters:
  • uid (string) - unique identifier of an object
Decorators:
  • @serviceConnectionError

getZenProperty(self, uid, zProperty)

source code 

Returns information about a zproperty for a given context, including its value

Returns: Dictionary
Properties:
  • path: (string) where the property is defined
  • type: (string) type of zproperty it is
  • options: (Array) available options for the zproperty
  • value (Array) value of the zproperty
  • valueAsString (string)
Decorators:
  • @serviceConnectionError

getCustomProperties(self, uid, start=0, params="{}", limit=None, sort=None, page=None, dir='ASC')

source code 

Returns the definition and values of all the zen properties for this context

Parameters:
  • uid (string) - unique identifier of an object
Decorators:
  • @serviceConnectionError

setZenProperty(self, uid, zProperty, value=None)

source code 

Sets the zProperty value.

Parameters:
  • uid (string) - unique identifier of an object
  • zProperty (string or dictionary) - either a string that represents which zproperty we are changing or key value pair dictionary that is the list of zproperties we wish to change.
  • value (anything) - if we are modifying a single zproperty then it is the value, it is not used if a dictionary is passed in for zProperty
Decorators:
  • @serviceConnectionError
  • @contextRequire(ZEN_ZPROPERTIES_EDIT, 'uid')

deleteZenProperty(self, uid, zProperty)

source code 

Removes the local instance of the each property in properties. Note that the property will only be deleted if a hasProperty is true * also used on custom properties or cProperties

Parameters:
  • uid (String) - unique identifier of an object
  • properties (String) - zenproperty identifier
Decorators:
  • @serviceConnectionError
  • @contextRequire(ZEN_ZPROPERTIES_EDIT, 'uid')