Package comodit_client :: Package api :: Module store :: Class IsStoreCapable

Class IsStoreCapable

Base class for all entities that are publishable/purchasable.

Instance Methods

file-like object

get_thumbnail_content(self)
Fetches the thumbnail of the entity.

read_thumbnail_content(self)

set_thumbnail_content(self, path)
Uploads the content of the thumbnail.

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
	published_as If the entity has been published, gives the UUID of published entity.
	purchased_as If the entity has been purchased, gives the UUID of purchased entity.
	can_pull If the entity has been purchased, tells if changes may be pulled from the store i.e.
	can_push If the entity has been published, tells if changes may be pushed to the store i.e.
string	url_f URL to entity's WEB site.
string	documentation Entity's documentation.
string	license Entity's license.
string	price Entity's price.
Inherited from `entity.Entity`: `client`, `description`, `identifier`, `label`, `name`, `url`, `uuid` Inherited from `object`: `__class__`

Method Details

get_thumbnail_content(self)

Fetches the thumbnail of the entity.

Returns: file-like object: a reader to file's content.

set_thumbnail_content(self, path)

Uploads the content of the thumbnail.

Parameters:

path (string) - Path to local thumbnail file.

Property Details

published_as

If the entity has been published, gives the UUID of published entity.

Get Method:: unreachable.published_as(self) - If the entity has been published, gives the UUID of published entity.

See Also: PublishedEntity

purchased_as

If the entity has been purchased, gives the UUID of purchased entity.

Get Method:: unreachable.purchased_as(self) - If the entity has been purchased, gives the UUID of purchased entity.

See Also: PurchasedEntity

can_pull

If the entity has been purchased, tells if changes may be pulled from the store i.e. published entity has been updated and this entity is therefore obsolete.

Get Method:: unreachable.can_pull(self) - If the entity has been purchased, tells if changes may be pulled from the store i.e.

can_push

If the entity has been published, tells if changes may be pushed to the store i.e. entity has been updated and published entity is therefore obsolete.

Get Method:: unreachable.can_push(self) - If the entity has been published, tells if changes may be pushed to the store i.e.

url_f

URL to entity's WEB site.

Get Method:: unreachable.url_f(self) - URL to entity's WEB site.
Set Method:: unreachable.url_f(self, url) - Sets the URL to entity's WEB site.
Type:: string

documentation

Entity's documentation.

Get Method:: unreachable.documentation(self) - Entity's documentation.
Set Method:: unreachable.documentation(self, documentation) - Sets entity's documentation.
Type:: string

license

Entity's license.

Get Method:: unreachable.license(self) - Entity's license.
Set Method:: unreachable.license(self, license_text) - Sets entity's license.
Type:: string

price

Entity's price.

Get Method:: unreachable.price(self) - Entity's price.
Set Method:: unreachable.price(self, price) - Sets entity's price.
Type:: string