Package 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 class for manipulation of Textbaustein entities.

Author:

XIMA MEDIA GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
TextbausteinAPI()

Method Summary

Modifier and Type	Method	Description
List<Textbaustein>	getAllByMandantAndTyp(UserContext uc, Mandant client, ETextbausteinKategorie category)	Method for reading all templates of a client and a specified type.
Textbaustein	getByClientAndMessageCode(UserContext uc, Mandant client, ETextbausteinMsgCode messageCode)	Finds a text template by its message code.
Textbaustein	getByMandantAndName(UserContext uc, int mandantID, String templateName)
Textbaustein	getByMandantAndName(UserContext uc, Mandant mandant, String name)
Textbaustein	getByUUID(UserContext uc, Mandant client, String uuid)	Method for determining an Textbaustein by an UUID as String and the client
Textbaustein	getByUUID(UserContext uc, Mandant client, UUID uuid)	Method for determining an Textbaustein by an UUID and the client
Textbaustein	getFD2Theme(UserContext uc, Mandant mandant, String theme)	Deprecated. Form themes can now come from a variety of sources, see FormThemeReference.
Map<String,String>	getI18nValues(UserContext uc, Textbaustein tmpl)	Method for determining all i18n values of a Textbaustein.
Textbaustein	getTextbausteinBy(UserContext uc, Mandant mandant, String name, ETextbausteinKategorie category)	Method for determining a Textbaustein by his name and category.
List<Textbaustein>	getTextbausteine(UserContext uc, Mandant mandant)	Method for determining all Textbaustein of a client.
String	mandantSpecificMsg(UserContext uc, Mandant client, ETextbausteinMsgCode messageCode)	Finds the content of a text template by its message code.

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

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, 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 client,
                                 ETextbausteinMsgCode messageCode)

Finds the content of a text template by its message code.

Parameters:

uc - The user context of the user who requested the message.

client - The client who owns the template.

messageCode - The message code of the template.

Returns:

The text content of the template.

Since:

2.4.3

getByClientAndMessageCode

public Textbaustein getByClientAndMessageCode(UserContext uc,
                                              Mandant client,
                                              ETextbausteinMsgCode messageCode)

Finds a text template by its message code.

Parameters:

uc - The user context of the user who requested the message.

client - The client who owns the template.

messageCode - The message code of the template.

Returns:

The template or null if no template was found.

Since:

8.3.0

getTextbausteine

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

Method for determining all Textbaustein of a client.

Parameters:

uc - UserContext the user context in which the action is to be performed.

mandant - Mandant whose templates are searched for.

Returns:

List of Textbausteins.

Since:

2.4.3

getTextbausteinBy

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

Method for determining a Textbaustein by his name and category.

Parameters:

uc - UserContext the user context in which the action is to be performed.

mandant - Mandant whose template is searched for.

name - String of the template.

category - ETextbausteinKategorie the type of the template.

Returns:

Textbaustein which is found for the parameters.

getByMandantAndName

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

Parameters:

uc - UserContext the user context in which the action is to be performed.

mandant - Mandant whose template is searched for.

name - String of the template.

Returns:

Textbaustein which is found for the parameters. Deprecated use getTextbausteinBy(UserContext, Mandant, String, ETextbausteinKategorie)

getByMandantAndName

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

Parameters:

uc - UserContext the user context in which the action is to be performed.

mandantID - Integer id of the client whose templates is searched for.

templateName - String name of the template.

Returns:

Textbaustein which is found for the parameters. Deprecated use getTextbausteinBy(UserContext, Mandant, String, ETextbausteinKategorie)

getFD2Theme

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

Deprecated.

Form themes can now come from a variety of sources, see FormThemeReference. The closest equivalent to CSS text templates are ClientFormTheme. See FormThemeAPI.

Method for reading a CSS template of a client by his name.

Parameters:

uc - UserContext the user context in which the action is to be performed.

mandant - Mandant whose template are searched for.

theme - String name of the themes.

Returns:

Textbaustein which is found for the parameters.

Since:

2.4.3

getAllByMandantAndTyp

public List<Textbaustein> getAllByMandantAndTyp(UserContext uc,
                                                Mandant client,
                                                ETextbausteinKategorie category)

Method for reading all templates of a client and a specified type.

Parameters:

uc - UserContext the user context in which the action is to be performed.

client - Mandant whose templates are searched for.

category - ETextbausteinKategorie the type of the template.

Returns:

List of Textbausteins.

Since:

2.4.3

getI18nValues

public Map<String,String> getI18nValues(UserContext uc,
                                              Textbaustein tmpl)

Method for determining all i18n values of a Textbaustein.

Parameters:

uc - UserContext the user context in which the action is to be performed.

tmpl - Textbaustein, whose custom attributes are to be determined.

Returns:

Map with elements.

Since:

4.2.0

getByUUID

public Textbaustein getByUUID(UserContext uc,
                              Mandant client,
                              String uuid)

Method for determining an Textbaustein by an UUID as String and the client

Parameters:

uc - UserContext the user context in which the action is to be performed.

client - Mandant whose templates are searched for.

uuid - the UUID as String

Returns:

the Textbaustein or null

getByUUID

public Textbaustein getByUUID(UserContext uc,
                              Mandant client,
                              UUID uuid)

Method for determining an Textbaustein by an UUID and the client

Parameters:

uc - UserContext the user context in which the action is to be performed.

client - Mandant whose templates are searched for.

uuid - the UUID

Returns:

the Textbaustein or null