components.version_manager.api¶
Version Manager API
-
components.version_manager.api.disable(version_manager)¶ Disable an object, then saves it.
Parameters: version_manager – Returns:
-
components.version_manager.api.disable_version(version, new_current=None)¶ Disable a version of the object, then saves it.
Parameters: - version –
- new_current –
Returns:
-
components.version_manager.api.get(version_manager_id)¶ Get a version manager by its id.
Parameters: version_manager_id – Returns:
-
components.version_manager.api.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
-
components.version_manager.api.get_by_id_list(list_id)¶ Get a version managers with the given id list.
Parameters: list_id – Returns:
-
components.version_manager.api.get_current(version_manager)¶ Get the current version of the version manager.
Parameters: version_manager – Returns:
-
components.version_manager.api.get_from_version(version)¶ Return a version manager from a version.
Parameters: version – Returns:
-
components.version_manager.api.get_global_version_managers()¶ Return all Version Managers with user set to None.
Returns:
-
components.version_manager.api.get_version_by_number(version_manager, version_number)¶ Return the version by its version number.
Parameters: - version_manager –
- version_number – Number of the version.
Returns:
-
components.version_manager.api.get_version_number(version_manager, version)¶ Return version number from version id.
Parameters: - version_manager –
- version –
Returns:
-
components.version_manager.api.insert_version(version_manager, version)¶ Insert a version in the version manager, then saves it.
Parameters: - version_manager –
- version –
Returns:
-
components.version_manager.api.restore(version_manager)¶ Restore an object, then saves it.
Parameters: version_manager – Returns:
-
components.version_manager.api.restore_version(version)¶ Disable a version of the object, then saves it.
Parameters: version – Returns:
-
components.version_manager.api.set_current(version)¶ Set the current version of the object, then saves it.
Parameters: version – Returns:
-
components.version_manager.api.upsert(version_manager)¶ Save or update version manager.
Parameters: version_manager – Returns: