components.version_manager.models

Version Manager model

class components.version_manager.models.VersionManager(*args, **kwargs)

Bases: django_mongoengine.document.DjangoFlavor, mongoengine.document.Document

Version Manager

exception DoesNotExist

Bases: mongoengine.errors.DoesNotExist

exception MultipleObjectsReturned

Bases: mongoengine.errors.MultipleObjectsReturned

clean()

Clean is called before saving

Returns:

current
disable()

Disable the Version Manager.

Returns:

disable_version(version)

Disable a version.

Parameters:version

Returns:

disabled_versions
static get_active_global_version_manager()

Return all active Version Managers with user set to None.

Returns:

static get_active_global_version_manager_by_title(version_manager_title)

Return active Version Manager by its title with user set to None.

Parameters:version_manager_title – Version Manager title
Returns:Version Manager instance
static get_active_version_manager_by_user_id(user_id)

Return all active Version Managers with given user id.

Returns:

static get_all()

Return all Version Managers.

Returns:

static get_all_version_manager_by_user_id(user_id)

Return all Version Managers with given user id.

Parameters:user_id – user_id.

Returns:

static get_all_version_manager_except_user_id(user_id)

Return all Version Managers of all users except user with given user id.

Parameters:user_id – user_id.

Returns:

static get_by_id(version_manager_id)

Return Version Managers by id.

Parameters:version_manager_id

Returns:

static get_by_id_list(list_id)

Return Version Managers with the given id list.

Parameters:list_id

Returns:

static get_disable_global_version_manager()

Return all disabled Version Managers with user set to None.

Returns:

static get_disable_version_manager_by_user_id(user_id)

Return all disabled Version Managers with given user id.

Returns:

get_disabled_versions()

Get the list disabled versions of the version manager.

Returns:

static get_global_version_managers()

Return all Version Managers with user set to None.

Returns:

get_version_by_number(version_number)

Return the version by its version number.

Parameters:version_number – Number of the version.

Returns:

Raises:DoesNotExist – Version does not exist.
get_version_number(version_id)

Return version number from version id.

Parameters:version_id

Returns:

Raises:DoesNotExist – Version does not exist.
id

A field wrapper around MongoDB’s ObjectIds.

insert(version)

Insert a version in the Version Manager.

Parameters:version

Returns:

is_disabled
restore()

Restore the Version Manager.

Returns:

restore_version(version)

Restore a version.

Parameters:version

Returns:

save_version_manager()

Custom save.

Returns:Saved Instance.
set_current_version(version)

Set the current version.

Parameters:version

Returns:

title
user
versions