Package comodit_client :: Package api :: Module settings :: Class SettingCollection

Class SettingCollection

Collection of settings.

Instance Methods

SimpleSetting

new_simple(self, key, value)
Instantiates a new simple setting.

LinkSetting

new_link(self, key, link, default)
Instantiates a new link setting.

PropertySetting

new_property(self, key, prop)
Instantiates a new link setting.

SimpleSetting

update(self, key, new_val)
Updates the value of a remote simple setting.

SimpleSetting

create(self, key, value)
A call to this method is equivalent to create_simple(key, value).

SimpleSetting

create_simple(self, key, value)
Creates a remote simple setting.

LinkSetting

create_link(self, key, link, default)
Creates a remote link setting.

PropertySetting

create_property(self, key, prop)
Creates a remote property setting.

LinkSetting

get_as_link(self, key)
Fetches a setting and converts it into a link setting.

change(self, settings, no_delete=False)

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_simple(self, key, value)

Instantiates a new simple setting.

Parameters:

key (string) - setting's key.
value (JSON object) - setting's value.

Returns: SimpleSetting

a new simple setting.

new_link(self, key, link, default)

Instantiates a new link setting.

Parameters:

key (string) - setting's key.
link (string) - setting's link.
default (JSON object) - setting's default value.

Returns: LinkSetting

a new link setting.

new_property(self, key, prop)

Instantiates a new link setting.

Parameters:

key (string) - setting's key.
prop (string) - setting's property.

Returns: PropertySetting

a new property setting.

update(self, key, new_val)

Updates the value of a remote simple setting.

Parameters:

key (string) - Setting's key.
new_val (JSON object) - New setting value.

Returns: SimpleSetting

Updated setting.

create(self, key, value)

A call to this method is equivalent to create_simple(key, value).

Returns: SimpleSetting: New setting's representation.

create_simple(self, key, value)

Creates a remote simple setting.

Parameters:

key (string) - setting's key.
value (JSON object) - setting's value.

Returns: SimpleSetting

a new simple setting.

create_link(self, key, link, default)

Creates a remote link setting.

Parameters:

key (string) - setting's key.
link (string) - setting's link.
default (JSON object) - setting's default value.

Returns: LinkSetting

a new link setting.

create_property(self, key, prop)

Creates a remote property setting.

Parameters:

key (string) - setting's key.
prop (string) - setting's property.

Returns: PropertySetting

a new property setting.

get_as_link(self, key)

Fetches a setting and converts it into a link setting.

Parameters:

key (string) - Setting's key.

Returns: LinkSetting

A link setting.

change(self, settings, no_delete=False)

Parameters:

settings (List of Setting) - the new settings list