DocFile prototype

Die DocFile Klasse wurde um einige spezifische Funktionen erweitert.

 

/** Fügt einen Kommentar zum Historienfeld "Comment" hinzu.
 * Bei einer Split-Mappe wird der Kommentar auch zur Haupt-Mappe hinzugefügt.
 * @param {string} comment Kommentar-Angabe
 * @returns {string} Leerer String oder Fehlermeldung
 **/
DocFile.addComment( comment )

 

/** Vergleicht einen Feldwert mit einem String-Wert.
 * Diese Funktion wird zum Beispiel bei der Auswertung der Workflow-Regeln oder bei der Parameter-Ermittlung verwendet.
 * @param {string} techFieldName Technischer Feldname
 * @param {string} stringValue Vergleichs-Angabe
 * @param {string} optCompareType Optionale Angabe eines Vergleichstyps. Als Default-Wert wird "=" verwendet.
 *                                                         Erlaubte Typen sind: '=', '<', '<=', '>', '>=', '..', '|~', '!=', 'expr'
 * @returns {string} true (Vergleichswert passt zum Feldwert) / false (Vergleichswert passt nicht zum Feldwert)
 **/
DocFile.compareFieldValueWithString( techFieldName, stringValue, optCompareType )

 

/** Löscht alle Sub-Mappen zu einer Haupt-Mappe
 * @returns {string} Leerer String oder Fehlermeldung
 **/
DocFile.deleteSubFiles()

 

/** Liefert die ID zu einem ausgehenden Workflow-Kontrollfluss-Namen.
 * @param {string} paramCfName Kontrollfluss-Name
 * @param {boolean} paramCfStartsWith Optionale Angabe, wenn der Kontrollfluss-Name nur mit dem 'paramCfName' beginnt.
 * @returns {string} Leerer String oder Kontrollfluss ID
 **/
DocFile.getControlFlowIdByName( paramCfName, paramCfStartsWith )

 

/** Liefert die ID eines ausgehenden Kontrollflusses zum Abschluss einer Aktion passend zur angegebenen Navigation.
 * Bei einer Weiterleitung über eine benutzerdefinierte Aktion muss die anschließende Navigation
 * über die Skript-Rückgabe gesteuert werden! 
 * @param {string} paramNavigation Navigation("keepfile", "next", "overview", "inbox", "folder").
 * @returns {string} Leerer String oder Kontrollfluss ID
 **/
DocFile.getActionEndControlFlowIdByNavigation( paramNavigation)

 

/** Ermittelt die in den Workflow-Aktionen konfigurierte Navigation nach Abschluss der Aktion.
 * @returns {string} Leerer String oder Navigation("keepfile", "next", "overview", "inbox", "folder")
 **/
DocFile.getActionEndNavigation()

 

/** Wenn zu einem Beleg Split-Mappen erstellt werden, dann wartet die Haupt-Mappe auf die vollständige Abarbeitung
 * aller Split-Mappen.
 * Der Workflow-Verlauf der Split-Mappen ist nur im Monitor der einzelnen Split-Mappen nachzuvollziehen.
 * Die Split-Mappen werden allerdings nach der Verarbeitung gelöscht.
 * Über diese Funktion können Monitor-Einträge zur Hauptmappe hinzugefügt werden.
 * @param {string} comment Optionale Angabe für den Kommentar beim Monitor-Eintrag.
 * @returns {boolean} true / false
 **/
DocFile.forwardMainFile( comment )

 

/** Wenn eine Mappe in einer technischen Aktion durch einen Job verarbeitet werden soll,
 * dann kann der Job die Mappe mit dieser Funktion weiterleiten.
 * @param {string} controlFlow OKontrollfluss-Name ('TechActionEnd' oder Default: 'TechActionEndManually').
 * @param {string} comment Optionale Angabe für den Kommentar beim Monitor-Eintrag.
 * @returns {boolean} true / false
 **/
DocFile.forwardMainFile( controlFlow, comment )

 

/** Gibt eine Liste aller sperrenden Benutzer und Gruppen im Workflow aus.
 * Die Funktion iteriert über alle sperrenden Workflow-Schritte.
 * @param {string} pListSeparator Trennzeichen zwischen den Angaben.
 * @returns {string} true / false
 **/
DocFile.listLockingUser( pListSeparator )