5.1.6. controllers.document — Controllers for documents

class plmapp.controllers.document.DocumentController(obj, user, block_mails=False, no_index=False)

Bases: openPLM.plmapp.controllers.plmobject.PLMObjectController

A PLMObjectController which manages Document

It provides methods to add or delete files, (un)lock them and attach a Document to a Part.

classmethod create_from_form(form, user, *args, **kwargs)

has_standard_related_locked(new_filename)

Returns True if settings.ENABLE_NATIVE_FILE_MANAGEMENT is True and exists a document that contains a standard locked file related to the file we want to add.

We use it to avoid to add a native file while a related standard locked file is present in the document.

Parameters:new_filename – name of the added file

check_edit_files()

lock(doc_file)

Lock doc_file so that it can not be modified or deleted if doc_file has a native related file this will be deprecated

Exceptions raised:  

• ValueError if doc_file.document is not self.object
• PermissionError if _user is not the owner of object
• PermissionError if object is not editable.
• LockError if doc_file is already locked
• ValueError if doc_file has a native related file locked

Parameters:

doc_file (DocumentFile) –

unlock(doc_file)

Unlock doc_file so that it can be modified or deleted

Exceptions raised:  

• ValueError if doc_file.document is not self.object
• plmapp.exceptions.UnlockError if doc_file is already unlocked or doc_file.locker is not the current user

Parameters:

doc_file (DocumentFile) –

add_file(f, update_attributes=True, thumbnail=True)

Adds file f to the document. f should be a File with an attribute name (like an UploadedFile).

If update_attributes is True (the default), handle_added_file() will be called with f as parameter.

Returns:the DocumentFile created. Raises :PermissionError if _user is not the owner of object Raises :PermissionError if object is not editable. Raises :ValueError if the file size is superior to settings.MAX_FILE_SIZE Raises :ValueError if we try to add a native file while a relate standar file locked is present in the Document

add_thumbnail(doc_file, thumbnail_file)

Sets thumnail_file as the thumbnail of doc_file. thumbnail_file should be a File with an attribute name (like an UploadedFile).

Exceptions raised:  

• ValueError if doc_file.document is not self.object
• ValueError if the file size is superior to settings.MAX_FILE_SIZE
• PermissionError if _user is not the owner of object
• PermissionError if object is not editable.

delete_file(doc_file)

Deletes doc_file, the file attached to doc_file is physically removed.

Exceptions raised:  

• ValueError if doc_file.document is not self.object
• plmapp.exceptions.DeleteFileError if doc_file is locked
• PermissionError if _user is not the owner of object
• PermissionError if object is not editable.

Parameters:

doc_file (DocumentFile) – the file to be deleted

handle_added_file(doc_file)

Method called when adding a file (method add_file()) with updates_attributes set to True.

This method may be overridden to updates attributes with data from doc_file. The default implementation does nothing.

Parameters:doc_file (DocumentFile) –

attach_to_part(part)

Links part (a Part) with object.

detach_part(part)

Deletes link between part (a Part) and object.

get_attached_parts(time=None)

Returns all parts attached to object.

get_detachable_parts()

Returns all attached parts the user can detach.

is_part_attached(part)

Returns True if part is attached to the current document.

check_attach_part(part, detach=False)

can_attach_part(part)

Returns True if part can be attached to the current document.

can_detach_part(part)

Returns True if part can be detached.

get_suggested_parts()

Returns a QuerySet of parts a user may want to attach to a future revision.

revise(new_revision, selected_parts=(), **kwargs)

checkin(doc_file, new_file, update_attributes=True, thumbnail=True)

Updates doc_file with data from new_file. doc_file.thumbnail is deleted if it is present.

Exceptions raised:  

• ValueError if doc_file.document is not self.object
• ValueError if the file size is superior to settings.MAX_FILE_SIZE
• plmapp.exceptions.UnlockError if doc_file is locked but doc_file.locker is not the current user
• PermissionError if _user is not the owner of object
• PermissionError if object is not editable.

Parameters:

• doc_file (DocumentFile) –
• new_file – file with new data, same parameter as f in add_file()
• update_attributes – True if handle_added_file() should be called

update_rel_part(formset)

Updates related part informations with data from formset

Parameters:formset (a modelfactory_formset of ModifyRelPartForm) –

update_file(formset)

Updates uploaded file informations with data from formset

Parameters:formset (a modelfactory_formset of ModifyFileForm) – Raises :PermissionError if _user is not the owner of object Raises :PermissionError if object is not editable.

cancel()

Cancels the object:

• calls PLMObjectController.cancel()
• removes all DocumentPartLink related to the object

check_cancel(raise_=True)

clone(form, user, parts, block_mails=False, no_index=False)

Clones the object :

• calls PLMObjectController.clone()
• duplicates all DocumentFile in self.object

Parameters:parts – list of Part selected to be attached to the new document

has_links()

Return true if the document is attached to at least one part.

publish()

unpublish()

promote(*args, **kwargs)

demote(*args, **kwargs)

object