Package comodit_client :: Package api :: Module parameters :: Class HasParameters

Class HasParameters

Super class for entities having parameters.

Instance Methods

ParameterCollection

parameters(self)
Instantiates a collection of parameters.

Parameter

get_parameter(self, name)
Fetches a parameter given its name.

add_parameter(self, parameter)
Adds a parameter to local list of parameters.

Inherited from entity.Entity: __init__, create, delete, dump, load, refresh, rename, show, update

Inherited from util.json_wrapper.JsonWrapper: dump_json, get_json, get_real_json, load_json, print_json, set_json

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

list of Parameter parameters_f
The local list of parameters.

Inherited from entity.Entity: client, description, identifier, label, name, url, uuid

Inherited from object: __class__

Method Details

get_parameter(self, name)

Fetches a parameter given its name.

Parameters:

name (string) - Parameter's name.

Returns: Parameter

Requested parameter.

add_parameter(self, parameter)

Adds a parameter to local list of parameters. Note that this list is considered only at creation time. For later parameter modifications, collection must be used.

Parameters:

parameter (Parameter) - the parameter to add.

Property Details

parameters_f

The local list of parameters. The object of the list may be used to interact with the server.

Get Method:: unreachable.parameters_f(self) - The local list of parameters.
Set Method:: unreachable.parameters_f(self, params) - Sets the local list of parameters.
Type:: list of Parameter