| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung |
| primus:checkparentsstatus [2023/02/08 12:01] – Externe Bearbeitung 127.0.0.1 | primus:checkparentsstatus [2024/09/05 08:07] (aktuell) – Wikilink geändert mgras |
|---|
| ====== CheckParentsStatus ====== | ====== CheckParentsStatus ====== |
| Die [[:funktion]] **CheckParentStatus** überprüft ob die auf ein Dokument verlinkenden Dokumente, einen bestimmten [[Status]] haben. Dies kann Beispielsweise beim Ungültig machen von Dokumenten als [[Bedingung]] benutzt werden, um zu prüfen ob das Dokument noch irgendwo in einem gültigen Dokument verwendet wird. In dem Fall wird dem Anwender ein Hinweistext angezeigt. Die Funktion geht alle übergeordneten Dokumente (Parents), nacheinander durch, hat ein Dokument nicht den gewünschten Status, dann wird eine definierte Meldung ausgegeben und als [[CheckParentsStatus#Rückgabewert]] ''FALSE'' zurückgegeben. Für die Prüfung jedes Parents werden die betreffenden Werte in [[CheckParentsStatus#spezielle Platzhalter|speziellen Platzhaltern]] abgelegt und können für Bedingungen und Meldungen benutzt werden. | Die [[Glossar#Funktion]] **CheckParentStatus** überprüft ob die auf ein Dokument verlinkenden Dokumente, einen bestimmten [[Status]] haben. Dies kann Beispielsweise beim Ungültig machen von Dokumenten als [[Bedingung]] benutzt werden, um zu prüfen ob das Dokument noch irgendwo in einem gültigen Dokument verwendet wird. In dem Fall wird dem Anwender ein Hinweistext angezeigt. Die Funktion geht alle übergeordneten Dokumente (Parents), nacheinander durch, hat ein Dokument nicht den gewünschten Status, dann wird eine definierte Meldung ausgegeben und als [[CheckParentsStatus#Rückgabewert]] ''FALSE'' zurückgegeben. Für die Prüfung jedes Parents werden die betreffenden Werte in [[CheckParentsStatus#spezielle Platzhalter|speziellen Platzhaltern]] abgelegt und können für Bedingungen und Meldungen benutzt werden. |
| |
| ===== Rückgabewert ===== | ===== Rückgabewert ===== |
| |''condition''| | ''TRUE''/''FALSE''| Es werden nur Dokumente geprüft, die diese [[Bedingung]] erfüllen| | |''condition''| | ''TRUE''/''FALSE''| Es werden nur Dokumente geprüft, die diese [[Bedingung]] erfüllen| |
| |''parameter''^ 1| ''%FILEPATH%''| Pfad zum zu prüfenden Dokument| | |''parameter''^ 1| ''%FILEPATH%''| Pfad zum zu prüfenden Dokument| |
| |:::^ 2| ''<FELDNAME>''| Name des zu prüfenden [[:datenfeld]]s| | |:::^ 2| ''<FELDNAME>''| Name des zu prüfenden [[Daten-XML#Datenfeld]]s| |
| |:::^ 3| ''<WERT>''| Mit diesem Wert wird der Inhalt von ''<FELDNAME>'' verglichen, Soll mit mehreren Werten möglichen Werten verglichen werden, dann sind diese durch Punkte (''.'') voneinander zu trennen ("''.003.004.005.''")| | |:::^ 3| ''<WERT>''| Mit diesem Wert wird der Inhalt von ''<FELDNAME>'' verglichen, Soll mit mehreren Werten möglichen Werten verglichen werden, dann sind diese durch Punkte (''.'') voneinander zu trennen ("''.003.004.005.''")| |
| |:::^ 4| ''<Bedingung>''| Gibt eine Bedingung an mit der die zu prüfenden Parentdokumente eingegrenzt werden können| | |:::^ 4| ''<Bedingung>''| Gibt eine Bedingung an mit der die zu prüfenden Parentdokumente eingegrenzt werden können| |
| |:::^ 5| ''<MELDUNGSTEXT>''| Text der im Fehlerfall dem Anwender angezeigt werden soll. Die Angabe mittels [[:interfacetext]] ist möglich| | |:::^ 5| ''<MELDUNGSTEXT>''| Text der im Fehlerfall dem Anwender angezeigt werden soll. Die Angabe mittels [[Elementtext]] ist möglich| |
| Die Übergabewerte von **parameter** werden durch ein ''|'' voneinander getrennt und müssen in der angegebenen Reihenfolge übergeben werden. | Die Übergabewerte von **parameter** werden durch ein ''|'' voneinander getrennt und müssen in der angegebenen Reihenfolge übergeben werden. |
| |
| ===== Spezielle Platzhalter ===== | ===== Spezielle Platzhalter ===== |
| Diese Funktion stellt spezielle [[:platzhalter]] zur Verfügung. | Diese Funktion stellt spezielle [[Platzhalter]] zur Verfügung. |
| ^ Platzhalter^ Bedeutung^ | ^ Platzhalter^ Bedeutung^ |
| | [[:parent_extension]]| Enthält die [[:dateiendung]] des übergeordneten Dokuments| | | [[Parent_Extension]]| Enthält die [[Glossar#Dateiendung]] des übergeordneten Dokuments| |
| | [[:parent_filename]]| Enthält den Dateinamen ohne Dateiendung ...| | | [[Parent_Filename]]| Enthält den Dateinamen ohne Dateiendung ...| |
| | [[:parent_filepath]]| Enthält den kompletten Pfad mit Dateinamen und Dateiendung ...| | | [[Parent_Filepath]]| Enthält den kompletten Pfad mit Dateinamen und Dateiendung ...| |
| |
| ===== Beispiel ===== | ===== Beispiel ===== |
