Package de.xima.fc.handler.interfaces.entity

Interface ITextbausteinHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

TextbausteinHandler

public interface ITextbausteinHandler
extends IGenericHandler

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
Set<String>	findAllKeywords(UserContext uc, Mandant mandant, ETextbausteinKategorie kategorie)	Collects all currently existing keywords for the provided client and template type.
List<Textbaustein>	findTemplatesBy(UserContext uc, Mandant mandant, ETextbausteinKategorie kategorie, boolean initCustomAttribs)
Textbaustein	getByClientAndMessageCode(UserContext uc, Mandant client, ETextbausteinMsgCode messageCode)	Finds a text template by its message code.
Textbaustein	getByClientAndMessageCode(UserContext uc, Mandant client, ETextbausteinMsgCode messageCode, ETextbausteinKategorie category)	Finds a text template by its message code.
Textbaustein	getByMandantAndName(UserContext uc, Mandant mandant, String name)
Textbaustein	getByUUID(UserContext uc, Mandant client, String uuid)
Textbaustein	getByUUID(UserContext uc, Mandant client, UUID uuid)
Textbaustein	getByUUID(UserContext uc, UUID clientUuid, UUID uuid)
Map<String,String>	getI18nValues(UserContext uc, Textbaustein template)	Provides the i18n values from the template.
Textbaustein	getTextbausteinBy(UserContext uc, Mandant client, String name, ETextbausteinKategorie category)	Gets the textbaustein by.
List<Textbaustein>	getTextbausteine(UserContext uc, Mandant client)	Gets the all text templates of a client.
List<Textbaustein>	getTextbausteineByKategorie(UserContext uc, Mandant mandant, ETextbausteinKategorie kategorie)	Gets the textbausteine vom uebergebenen Typ.
TenantTemplateLocalizedFile	getUserPortalTenantTemplateLocalizedFile(UserContext uc, UUID portalUuid, UUID tenantUuid, UUID tenantTemplateUuid, UUID fileUuid)	Returns the tenant template file with the given file UUID in the context of the user portal with the given UUID.
String	mandantSpecificMsg(UserContext uc, Mandant client, ETextbausteinMsgCode messageCode)	Mandant specific msg.

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Method Detail

getTextbausteine

List<Textbaustein> getTextbausteine(UserContext uc,
                                    Mandant client)

Gets the all text templates of a client.

Parameters:

uc - The user context of the user who requested the text templates.

client - The client who owns the templates.

Returns:

All text templates of the client.

mandantSpecificMsg

String mandantSpecificMsg(UserContext uc,
                          Mandant client,
                          ETextbausteinMsgCode messageCode)

Mandant specific msg.

Parameters:

uc - the uc

client - the mandant

messageCode - the msg code

Returns:

the string @

getTextbausteinBy

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

Gets the textbaustein by.

Parameters:

uc - The user context of the user who requested the text template.

client - the mandant

name - the name

category - the category of the Textbaustein

Returns:

the Textbaustein

getTextbausteineByKategorie

List<Textbaustein> getTextbausteineByKategorie(UserContext uc,
                                               Mandant mandant,
                                               ETextbausteinKategorie kategorie)

Gets the textbausteine vom uebergebenen Typ.

Parameters:

uc - Usercontext in welchem die Operation ausgeführt wird

mandant - the mandant

kategorie - des textbausteins

Returns:

list of Textbaustein

getByMandantAndName

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

getI18nValues

Map<String,String> getI18nValues(UserContext uc,
                                       Textbaustein template)

Provides the i18n values from the template.

Parameters:

uc - user context in which the opration is performed

template - the template

Returns:

map of i18n values

getByUUID

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

getByUUID

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

getByUUID

Textbaustein getByUUID(UserContext uc,
                       UUID clientUuid,
                       UUID uuid)

getByClientAndMessageCode

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

getByClientAndMessageCode

Textbaustein getByClientAndMessageCode(UserContext uc,
                                       Mandant client,
                                       ETextbausteinMsgCode messageCode,
                                       ETextbausteinKategorie category)

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.

category - The category of the template.

Returns:

The template or null if no template was found.

Since:

8.3.9

findAllKeywords

Set<String> findAllKeywords(UserContext uc,
                            Mandant mandant,
                            ETextbausteinKategorie kategorie)

Collects all currently existing keywords for the provided client and template type.

Parameters:

uc - UserContext to be used for entity context creation

mandant - Mandant to filter the templates by

kategorie - ETextbausteinKategorie to filter the templates by

Returns:

the resulting set of keywords

Since:

8.4.0

findTemplatesBy

List<Textbaustein> findTemplatesBy(UserContext uc,
                                   Mandant mandant,
                                   ETextbausteinKategorie kategorie,
                                   boolean initCustomAttribs)

Parameters:

uc - UserContext to be used for entity context creation

mandant - Mandant to filter the templates by

kategorie - ETextbausteinKategorie to filter the templates by

initCustomAttribs - decides whether to initialize (i.e. fetch) the custom attributes of each template or not

Returns:

the resulting list of templates

Since:

8.4.0

getUserPortalTenantTemplateLocalizedFile

TenantTemplateLocalizedFile getUserPortalTenantTemplateLocalizedFile(UserContext uc,
                                                                     UUID portalUuid,
                                                                     UUID tenantUuid,
                                                                     UUID tenantTemplateUuid,
                                                                     UUID fileUuid)

Returns the tenant template file with the given file UUID in the context of the user portal with the given UUID.

Parameters:

uc - User context for accessing the database.

portalUuid - UUID of the user portal (context).

tenantUuid - UUID of the client (context).

tenantTemplateUuid - UUID of the tenant template.

fileUuid - UUID of the tenant template file.

Returns:

The tenant template file with the given UUID, or null if no such tenant template file exists.

Throws:

de.xima.cmn.http.exception.NotFoundException - if no portal with the given UUID exists, if no client with the given UUID exists, or if no tenant template with the given UUID exists.

Since:

8.4.0