IBPWorkflowDocument
Document class must implement methods of IBPWorkflowDocument interface. This interface contains methods that are required for workflow to work with a document.
For workflow to be able to work with an object, it is necessary to select what would be the document, what would be a document type, which identifiers will the document and the document type will be having. Additionally, document class must be implemented as per the IBPWorkflowDocument interface.
The document and the document type are defined by their identifiers, which have the form of a three-elements tuple: module code, document class name and a piece of code (as a rule, element code). For details, see the Document article.
Methods
| Name | Description | Available from version |
|---|---|---|
| CanUserOperateDocument | Verifies permission rights to complete operations with the specified document. | |
| CanUserOperateDocumentType | Verifies permission rights to complete operations with the documents of specified type | |
| CreateDocument | Creates new document with specified properties (fields) and returns its code. | |
| DeleteDocument | Deletes a specified document. | |
| GetAllowableOperations | This method for the document type returns an array of accessible operations. | |
| GetAllowableUserGroups | This method is designed for the document type is to be used to return an array of accessible user groups. | |
| GetDocument | This method returns properties (fields) of the document in the form of an associative array. | |
| GetDocumentAdminPage | This method designed for the document code and returns a link to a document page in the administrative section. | |
| GetDocumentFields | This method returns an array of properties (fields), that the document of this type has. | |
| GetDocumentForHistory | This method returns an array of arbitrary structure, containing all information about the document. | |
| GetUsersFromUserGroup | This method returns users of specified group to an indicated document as an array of user codes. | |
| IsDocumentLocked | This method verifies whether the specified document is blocked or not for the indicated workflow. | |
| LockDocument | This method blocks the specified document for the indicated workflow. | |
| PublishDocument | This method publishes document, i. e. makes it accessible in a public section of site. | |
| RecoverDocumentFromHistory | This method restores the specified document from an array. | |
| UnlockDocument | This method blocks the specified document. | |
| UnpublishDocument | This method de-publishes the document, i. e. makes inaccessible in a public section of site. | |
| UpdateDocument | This method modifies properties (fields) of the specified document to the indicated values. |
© «Bitrix24», 2001-2024