Class TextbausteinHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.entity.GenericHandler

de.xima.fc.handler.entity.TextbausteinHandler

All Implemented Interfaces:

IAPIHandler, IGenericHandler, ITextbausteinHandler, Serializable

public class TextbausteinHandler
extends GenericHandler
implements ITextbausteinHandler

The Class TextbausteinHandler.

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields inherited from class GenericHandler

LOG

Constructor Summary

Constructors

Constructor	Description
TextbausteinHandler()

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 client, String name)
Textbaustein	getByUUID(UserContext uc, Mandant client, String uuid)
Textbaustein	getByUUID(UserContext uc, Mandant client, 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 client, ETextbausteinKategorie category)	Gets the textbausteine vom uebergebenen Typ.
String	mandantSpecificMsg(UserContext uc, Mandant client, ETextbausteinMsgCode messageCode)	Mandant specific msg.

Methods inherited from class GenericHandler

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

Methods inherited from class AMSApiHandler

getName

Methods inherited from class Object

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

Methods inherited from interface IAPIHandler

getName

Methods inherited from interface IGenericHandler

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

Constructor Details

TextbausteinHandler

public TextbausteinHandler()

Method Details

getTextbausteine

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

Description copied from interface: ITextbausteinHandler

Gets the all text templates of a client.

Specified by:

getTextbausteine in interface ITextbausteinHandler

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

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

Description copied from interface: ITextbausteinHandler

Mandant specific msg.

Specified by:

mandantSpecificMsg in interface ITextbausteinHandler

Parameters:

uc - the uc

client - the mandant

messageCode - the msg code

Returns:

the string @

getTextbausteinBy

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

Description copied from interface: ITextbausteinHandler

Gets the textbaustein by.

Specified by:

getTextbausteinBy in interface ITextbausteinHandler

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

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

Description copied from interface: ITextbausteinHandler

Gets the textbausteine vom uebergebenen Typ.

Specified by:

getTextbausteineByKategorie in interface ITextbausteinHandler

Parameters:

uc - Usercontext in welchem die Operation ausgeführt wird

client - the mandant

category - des textbausteins

Returns:

list of Textbaustein

getByMandantAndName

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

Specified by:

getByMandantAndName in interface ITextbausteinHandler

getI18nValues

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

Description copied from interface: ITextbausteinHandler

Provides the i18n values from the template.

Specified by:

getI18nValues in interface ITextbausteinHandler

Parameters:

uc - user context in which the opration is performed

template - the template

Returns:

map of i18n values

getByUUID

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

Specified by:

getByUUID in interface ITextbausteinHandler

getByUUID

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

Specified by:

getByUUID in interface ITextbausteinHandler

getByClientAndMessageCode

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

Description copied from interface: ITextbausteinHandler

Finds a text template by its message code.

Specified by:

getByClientAndMessageCode in interface ITextbausteinHandler

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.

getByClientAndMessageCode

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

Description copied from interface: ITextbausteinHandler

Finds a text template by its message code.

Specified by:

getByClientAndMessageCode in interface ITextbausteinHandler

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.

findAllKeywords

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

Description copied from interface: ITextbausteinHandler

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

Specified by:

findAllKeywords in interface ITextbausteinHandler

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

findTemplatesBy

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

Specified by:

findTemplatesBy in interface ITextbausteinHandler

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