createDocTemplateFilter

Versionshinweise

18.2

Code

Groovy
ScriptDocTemplateFilter createDocTemplateFilter(String documentType)

Beschreibung

Erzeugung eines Filters für das Selektieren von Dokumentvorlagen.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

  • documentType
    Für diesen Dokumentvorlagentyp werden alle verfügbaren Dokumentvorlagen selektiert. Die Klasse DocumentUtils enthält die Liste der unterstützten Dokumenttypen, z.B. DocumentUtils.DOC_TYPE_LETTER

Rückgabe

Filterobjekt zur Selektion der Dokumentvorlagen per Methode getDocTemplateNamesWithFilter(ScriptDocTemplateFilter templateFilter).

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);