kepler.models.user_group module¶

The module defines the classes for database models related to user groups.

class kepler.models.user_group.UserGroup(owner_id, name, description, group_type_id)¶

Bases: sqlalchemy.ext.declarative.api.Base

The SQLAlchemy declarative model class for a UserGroup object holds information on user groups made by users.

active¶

Specifies whether the user group is active of has been deactivated.

description¶

The optional description of the user group.

id¶

The ID of the user group.

is_personal()¶

The function returns whether the user group is personal or a group shared by other users.

Returns:	True if the user group is personal.

name¶

The name of the user group.

owner_id¶

The user ID of the owner of the user group.

user_group_type_id¶

The reference to the UserGroupType database table specifies the type of the user group.

class kepler.models.user_group.UserGroupMember(user_group_id, user_id)¶

Bases: kepler.models.models_meta.ModifiableBase, sqlalchemy.ext.declarative.api.Base

The SQLAlchemy declarative model class for a UserGroupMember object. It links users to a user groups.

modifier_id¶

user_group_id¶

The reference to the UserGroup database table.

user_id¶

The reference to the User database table.

class kepler.models.user_group.UserGroupType(id, name_tr_id)¶

Bases: sqlalchemy.ext.declarative.api.Base

The class defines the SQLAlchemy model for the UserGroupType database table. The rows of the table reprensent the different types of user groups supported by the system.

active¶

Specifies whether the user group type is active or has been deactivated.

id¶

The ID of the user group type.

name_tr_id¶

The translation ID of the name of the user group type.