de.xima.fc.api.entity

Class TextbausteinAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<Textbaustein>

de.xima.fc.api.entity.TextbausteinAPI

public class TextbausteinAPI
extends AEntityAPI<Textbaustein>

API-Klassse zur Manipulation von Textbaustein-Entitäten

Author:

Michael Kohlsche

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor and Description
TextbausteinAPI()

Method Summary

Modifier and Type	Method and Description
List<Textbaustein>	getAllByMandantAndTyp(UserContext uc, Mandant mandant, ETextbausteinKategorie tbKat) Methode zum Auslesen aller Textbaustein eines Mandanten und eines bestimmten Typs
Textbaustein	getByMandantAndName(UserContext uc, int mandantID, String templateName) Deprecated.
Textbaustein	getByMandantAndName(UserContext uc, Mandant mandant, String name) Deprecated.
Textbaustein	getFD2Theme(UserContext uc, Mandant mandant, String theme) Methode zum Auslesen eines CSS-Textbausteins eines Mandanten anhand des Names
Textbaustein	getTextbausteinBy(UserContext uc, Mandant mandant, String name, ETextbausteinKategorie kategorie)
List<Textbaustein>	getTextbausteine(UserContext uc, Mandant mandant) Methode zum Ermitteln aller Textbausteine eines Mandantens.
String	mandantSpecificMsg(UserContext uc, Mandant mandant, ETextbausteinMsgCode textbausteinCode) Methode zum Ermitteln einer Nachricht basierend auf einem Mandanten und eines Textbaustein-Codes.

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, getAll, getAllBy, getBy, getById, resultTotalCount, update, update

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextbausteinAPI

public TextbausteinAPI()

Method Detail

mandantSpecificMsg

public String mandantSpecificMsg(UserContext uc,
                                 Mandant mandant,
                                 ETextbausteinMsgCode textbausteinCode)

Methode zum Ermitteln einer Nachricht basierend auf einem Mandanten und eines Textbaustein-Codes.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandant - Mandant dessen Nachricht ausgegeben werden soll

textbausteinCode - ETextbausteinMsgCode des Textbausteins der ausgegebn werden soll

Returns:

String die gesuchte Nachricht des Textbausteins

Since:

2.4.3

getTextbausteine

public List<Textbaustein> getTextbausteine(UserContext uc,
                                           Mandant mandant)

Methode zum Ermitteln aller Textbausteine eines Mandantens.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandant - Mandant dessen Textbausteine gesucht werden

Returns:

List von Textbausteinen @since 2.4.3

getTextbausteinBy

public Textbaustein getTextbausteinBy(UserContext uc,
                                      Mandant mandant,
                                      String name,
                                      ETextbausteinKategorie kategorie)

getByMandantAndName

@Deprecated
public Textbaustein getByMandantAndName(UserContext uc,
                                                    Mandant mandant,
                                                    String name)

Deprecated.

Deprecated use getTextbausteinBy(UserContext, Mandant, String, ETextbausteinKategorie)

getByMandantAndName

@Deprecated
public Textbaustein getByMandantAndName(UserContext uc,
                                                    int mandantID,
                                                    String templateName)

Deprecated.

Deprecated use getTextbausteinBy(UserContext, Mandant, String, ETextbausteinKategorie)

getFD2Theme

public Textbaustein getFD2Theme(UserContext uc,
                                Mandant mandant,
                                String theme)

Methode zum Auslesen eines CSS-Textbausteins eines Mandanten anhand des Names

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandant - Mandant dessen Textbausteine gesucht werden

theme - name des Themes

Returns:

Textbaustein @since 2.4.3

getAllByMandantAndTyp

public List<Textbaustein> getAllByMandantAndTyp(UserContext uc,
                                                Mandant mandant,
                                                ETextbausteinKategorie tbKat)

Methode zum Auslesen aller Textbaustein eines Mandanten und eines bestimmten Typs

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandant - Mandant dessen Textbausteine gesucht werden

tbKat - ETextbausteinKategorie

Returns:

List von Textbausteinen @since 2.4.3