Package comodit_client :: Package api :: Module parameters :: Class ParameterCollection

Class ParameterCollection

Collection of parameters.

Instance Methods

new(self, name, key, description='', default_value=None)
Instantiates a new parameter representation.

create(self, name, key, description='', default_value=None)
Creates a new remote parameter entity and returns its local representation.

Inherited from collection.Collection: __init__, __iter__, clear, delete, get, list, refresh

Inherited from object: __long__, __native__, __nonzero__, __unicode__, next

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

new(self, name, key, description=`''`, default_value=None)

Instantiates a new parameter representation.

Parameters:

name (string) - Parameter's name.
key (string) - Parameter's key.
description (string) - Parameter's description.
default_value (JSON object) - Parameter's default value.

Returns: Parameter

A parameter representation.

create(self, name, key, description=`''`, default_value=None)

Creates a new remote parameter entity and returns its local representation.