Document Reference Handling
- Last UpdatedNov 27, 2023
- 1 minute read
|
document_reference_get () =>document_reference_get (PanelName) |
||
|
The function returns a list of document references associated with the panel. |
||
|
Input parameters |
||
|
PanelName |
Name of the panel to get references for |
|
|
Returned value: |
||
|
[0] |
list |
List of DocumentReference instances |
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid arguments list |
|
|
kcs_ModelNotFound |
Panel not found |
|
|
kcs_GeneralError |
List of result can't be created for some internal reason |
|
|
document_reference_add (docRef) =>document_reference_add (docRef, PanelName) |
||
|
The function adds a document reference to the panel object. |
||
|
Input parameters |
||
|
DocRef |
DocumentReference |
Instance of Python DocumentReference class |
|
PanelName |
Name of the panel to add reference for |
|
|
Returned value: |
||
|
None |
||
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid arguments list |
|
|
kcs_ModelNotFound |
Panel not found |
|
|
document_reference_remove (docRef) =>document_reference_remove (docRef, PanelName) |
||
|
The function removes document reference from panel object. If there are more than one document reference, the first found will be deleted. |
||
|
Input parameters |
||
|
DocRef |
DocumentReference |
Instance of Python DocumentReference class |
|
PanelName |
Name of the panel to remove reference for |
|
|
Returned value: |
||
|
None |
||
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid arguments list |
|
|
kcs_ModelNotFound |
Panel not found |
|
|
kcs_DoesNotExist |
Equipment document reference doesn't exist |
|