5.1.7. controllers.group — Controllers for groups

This module contains a class called GroupController which provides a controller for Group. This class is similar to PLMObjectController but some methods from PLMObjectController are not defined.

class plmapp.controllers.group.GroupController(obj, user, block_mails=False, no_index=False)

Bases: openPLM.plmapp.controllers.base.Controller

Object used to manage a Group and store his modification in a history

Attributes :

object

The Group managed by the controller

Parameters:

• obj (an instance of Group) – managed object
• user (Group) – user who modify obj

Note

This class does not inherit from PLMObjectController.

HISTORY

alias of GroupHistory

classmethod create(name, description, user, data={})

classmethod create_from_form(form, user)

Creates a PLMObjectController from form and associates user as the creator/owner of the PLMObject.

This method raises ValueError if form is invalid.

Parameters:

• form – a django form associated to a model
• user – user who creates/owns the object

Return type:

PLMObjectController

classmethod load(type, reference, revision, user)

has_permission(role)

update_users(formset)

Updates users with data from formset

Parameters:formset (a formset_factory of ModifyUserForm) – Raises :PermissionError if _user is not the owner of object.

add_user(*args, **kwargs)

Permission required: owner

Asks user to join the group.

An email is sent to user so that he can validate its inscription.

Raises :ValueError if user’s email is empty.

ask_to_join()

Asks to join the group.

An email is sent to the group’s owner so that he can validate the inscription.

Raises :ValueError if the owner’s email is empty.

accept_invitation(invitation)

Accepts an invitation.

If the owner sent invitation, it checks that _user is the guest and adds him to the group.

If the guest sent invitation, it checks that _user is the owner and adds the guest to the group.

send_invitation_to_owner(invitation)

Sends a mail to the owner asking him to accept the invitation to join the group.

This method can be called to resend an invitation.

Raises :ValueError if the invitation’s state is not Invitation.PENDING

send_invitation_to_guest(invitation)

Sends a mail to the guest asking him to accept the invitation to join the group.

This method can be called to resend an invitation.

Raises :ValueError if the invitation’s state is not Invitation.PENDING

refuse_invitation(invitation)

Refuses an invitation.

If the owner sent invitation, it checks that _user is the guest and invitation is marked as refused.

If the guest sent invitation, it checks that _user is the owner and invitation is marked as refused.

save(with_history=True)

Saves object and records its history in the database. If with_history is False, the history is not recorded.

get_attached_parts()

get_attached_documents()

check_readable(raise_=True)

object