getDocTemplateNamesWithFilter

Versionshinweise

18.2

Code

Groovy
String[] getDocTemplateNamesWithFilter(ScriptDocTemplateFilter templateFilter) throws Exception

Beschreibung

Ermittelt die Namen aller Dokumentvorlagen basierend auf dem übergebenen Vorlagenfilter.

Folgende Filterkriterien stehen zur Verfügung

  • Typ der Dokumentvorlage
    Beispiel: DocumentUtils.DOC_TYPE_EXCEL

  • Entität der Dokumentvorlage
    Beispiel: ContactPerson

  • Nur native oder alle Dokumentvorlagen
    'native Dokumentvorlagen' ist die Voreinstellung

  • Dokumentkategorie der Dokumentvorlage - es wird der Primärschlüssel übergeben
    Beispiel: docCat-pk1

  • Dokumentenbereich der Dokumentvorlage - es wird der Primärschlüssel übergeben
    Beispiel: docRange-pk1

Hinweis
Alternativ kann auch die Methode DocumentUtils.getDocTemplateNames(String documentType) verwendet werden, wenn ausschließlich per Dokumententyp selektiert werden soll.

Parameter

  • templateFilter - Dieser Filter enthält alle Selektionskriterien zur Ermittlung der Dokumentvorlagen.

Rückgabe

Liste der Namen der selektierten Dokumentvorlagen basierend auf dem übergebenen Filter.

Beispiele

Groovy
ScriptDocTemplateFilter filter = DocumentUtils.createDocTemplateFilter(DocumentUtils.DOC_TYPE_LETTER);
DocumentUtils.setDocumentCategoryKey(filter, "docCat-pk1");
DocumentUtils.setDocumentRange(filter, "docRange-pk1");
String templateNames = DocumentUtils.getDocTemplateNamesWithFilter(filter);