Class TextbausteinDao

java.lang.Object

de.xima.cmn.dao.AbstractDao<Textbaustein, Long, IEntityContext>

de.xima.fc.dao.impl.GenericDao<Textbaustein>

de.xima.fc.dao.impl.MandantDependentBaseDao<Textbaustein>

de.xima.fc.dao.impl.TextbausteinDao

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IAbstractDao<Textbaustein, Long, IEntityContext>, IGenericDao<Textbaustein>, IMandantDependentBaseDao<Textbaustein>, ITextbausteinDao

public class TextbausteinDao
extends MandantDependentBaseDao<Textbaustein>
implements ITextbausteinDao

The default implementation of ITextbausteinDao that can be accessed via DaoProvider.

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from class de.xima.cmn.dao.AbstractDao

entityClass, LOG

Constructor Summary

Constructors

Constructor	Description
TextbausteinDao()	Creates a new instance of this DAO.

Method Summary

Modifier and Type	Method	Description
Set<String>	findAllKeywords(IEntityContext ec, Mandant mandant, ETextbausteinKategorie kategorie)	Collects all currently existing keywords for the provided client and template type.
String	findUniqueName(IEntityContext ec, Mandant client, String candidate)	Returns a name that is not taken by another Textbaustein in the given client.
String	findUniqueName(IEntityContext ec, Mandant client, String candidate, Textbaustein exclude)	Returns a name that is not taken by another Textbaustein in the given client other than the excluded template.
List<Textbaustein>	getAll(IEntityContext ec, Mandant mandant)
List<Textbaustein>	getAllByKat(IEntityContext ec, Mandant mandant, ETextbausteinKategorie kategorie)	Returns the templates matching the provided Mandant and ETextbausteinKategorie.
List<Textbaustein>	getAllByProject(IEntityContext ec, Projekt project)	Returns all templates that are being used by the given project
Textbaustein	getByKatAndName(IEntityContext ec, Mandant mandant, ETextbausteinKategorie kategorie, String name)
Textbaustein	getByMsgCode(IEntityContext ec, Mandant client, ETextbausteinMsgCode messageCode, ETextbausteinKategorie category)
Textbaustein	getByMsgCode(IEntityContext ec, Mandant client, String messageCode)
Textbaustein	getByMsgCode(IEntityContext ec, Mandant client, String messageCode, ETextbausteinKategorie category)
Textbaustein	getByName(IEntityContext ec, Mandant mandant, String name)
Textbaustein	getByUUID(IEntityContext ec, Mandant client, String uuid)	Returns the template with the given UUID string
Textbaustein	getByUUID(IEntityContext ec, Mandant client, UUID uuid)	Returns the template with the given UUID
Set<de.xima.cmn.dao.interfaces.IEntity<Long>>	getEntityRefs(IEntityContext ec, Textbaustein template)	Returns a set of entities that reference the given entity and depend on it.
protected IFCDaoActionHook<Textbaustein>	getPostActionHook()
protected IFCDaoActionHook<Textbaustein>	getPreActionHook()
Textbaustein	getTextbausteinByMsgCode(IEntityContext ec, Mandant client, ETextbausteinMsgCode messageCode)
boolean	isNameExisiting(IEntityContext ec, Mandant client, String name)	Checks whether the given template name exists within the given client

Methods inherited from class GenericDao

read

Methods inherited from class de.xima.cmn.dao.AbstractDao

all, bulkDelete, bulkUpdate, cb, checkLockingVersion, cq, create, create, delete, delete, deleteAll, executePagedDaoAction, getAttributes, getAttributes, getSingleAttributes, getSingleAttributes, getTransactionHandler, notifyListener, notifyListener, read, registerListener, registerListener, registerListener, resultTotalCount, setTransactionHandler, singleElement, unregisterListener, unregisterListener, unregisterListener, update, update

Methods inherited from class Object

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

Methods inherited from interface de.xima.cmn.dao.interfaces.IAbstractDao

all, bulkDelete, bulkUpdate, checkLockingVersion, create, create, delete, delete, deleteAll, executePagedDaoAction, getAttributes, getAttributes, getSingleAttributes, getSingleAttributes, getTransactionHandler, read, registerListener, registerListener, registerListener, resultTotalCount, setTransactionHandler, singleElement, unregisterListener, unregisterListener, unregisterListener, update, update

Methods inherited from interface IGenericDao

count, createOrUpdate, findAll, findSingle, read

Constructor Details

TextbausteinDao

public TextbausteinDao()

Creates a new instance of this DAO. Normally you should use the singleton instance provided by DaoProvider.TEXTBAUSTEIN_DAO.

Method Details

getEntityRefs

public Set<de.xima.cmn.dao.interfaces.IEntity<Long>> getEntityRefs(IEntityContext ec,
 Textbaustein template)

Description copied from interface: IGenericDao

Returns a set of entities that reference the given entity and depend on it. An entity can usually not be deleted if it is still being referenced by and depended on by other entities.

Specified by:

getEntityRefs in interface IGenericDao<Textbaustein>

Overrides:

getEntityRefs in class GenericDao<Textbaustein>

Parameters:

ec - entity context for database transactions.

template - to get references for.

Returns:

a set of entities that reference the given entity and depend on it.

getTextbausteinByMsgCode

public Textbaustein getTextbausteinByMsgCode(IEntityContext ec,
 Mandant client,
 ETextbausteinMsgCode messageCode)

Specified by:

getTextbausteinByMsgCode in interface ITextbausteinDao

getAll

public List<Textbaustein> getAll(IEntityContext ec,
 Mandant mandant)

Specified by:

getAll in interface ITextbausteinDao

getByName

public Textbaustein getByName(IEntityContext ec,
 Mandant mandant,
 String name)

Specified by:

getByName in interface ITextbausteinDao

getAllByKat

public List<Textbaustein> getAllByKat(IEntityContext ec,
 Mandant mandant,
 ETextbausteinKategorie kategorie)

Description copied from interface: ITextbausteinDao

Returns the templates matching the provided Mandant and ETextbausteinKategorie.

Specified by:

getAllByKat in interface ITextbausteinDao

Parameters:

ec - IEntityContext to use

mandant - Mandant context in which to look for template

kategorie - ETextbausteinKategorie to filter the templates by

Returns:

the resulting list of templates, ordered by template name (ASC)

getByMsgCode

public Textbaustein getByMsgCode(IEntityContext ec,
 Mandant client,
 String messageCode)

Specified by:

getByMsgCode in interface ITextbausteinDao

getByMsgCode

public Textbaustein getByMsgCode(IEntityContext ec,
 Mandant client,
 ETextbausteinMsgCode messageCode,
 ETextbausteinKategorie category)

Specified by:

getByMsgCode in interface ITextbausteinDao

getByMsgCode

public Textbaustein getByMsgCode(IEntityContext ec,
 Mandant client,
 String messageCode,
 ETextbausteinKategorie category)

Specified by:

getByMsgCode in interface ITextbausteinDao

getByKatAndName

public Textbaustein getByKatAndName(IEntityContext ec,
 Mandant mandant,
 ETextbausteinKategorie kategorie,
 String name)

Specified by:

getByKatAndName in interface ITextbausteinDao

getByUUID

public Textbaustein getByUUID(IEntityContext ec,
 Mandant client,
 String uuid)

Description copied from interface: ITextbausteinDao

Returns the template with the given UUID string

Specified by:

getByUUID in interface ITextbausteinDao

Parameters:

ec - IEntityContext to use

client - Mandant context in which to look for template

uuid - String UUID of the template

Returns:

Textbaustein for the given UUID and client

getByUUID

public Textbaustein getByUUID(IEntityContext ec,
 Mandant client,
 UUID uuid)

Description copied from interface: ITextbausteinDao

Returns the template with the given UUID

Specified by:

getByUUID in interface ITextbausteinDao

Parameters:

ec - IEntityContext to use

client - Mandant context in which to look for template

uuid - UUID UUID of the template

Returns:

Textbaustein for the given UUID and client

getAllByProject

public List<Textbaustein> getAllByProject(IEntityContext ec,
 Projekt project)

Description copied from interface: ITextbausteinDao

Returns all templates that are being used by the given project

Specified by:

getAllByProject in interface ITextbausteinDao

Parameters:

ec - IEntityContext to be used

project - Projekt project to search for templates

Returns:

List of Textbausteins that are being used by the project

findUniqueName

public String findUniqueName(IEntityContext ec,
 Mandant client,
 String candidate)

Description copied from interface: ITextbausteinDao

Returns a name that is not taken by another Textbaustein in the given client. An index will be added to the candidate if necessary.

Specified by:

findUniqueName in interface ITextbausteinDao

Parameters:

ec - IEntityContext to be used

client - Mandant for which a unique template name should be generated

candidate - Candidate name for the template. This name is used when it does not exist, otherwise a unique name is derived based on this name.

Returns:

unique template name in the context of the given client

findUniqueName

public String findUniqueName(IEntityContext ec,
 Mandant client,
 String candidate,
 Textbaustein exclude)

Description copied from interface: ITextbausteinDao

Returns a name that is not taken by another Textbaustein in the given client other than the excluded template. An index will be added to the candidate if necessary.

Specified by:

findUniqueName in interface ITextbausteinDao

Parameters:

ec - IEntityContext to be used

client - Mandant for which a unique template name should be generated

candidate - Candidate name for the template. This name is used when it does not exist, otherwise a unique name is derived based on this name.

exclude - Textbaustein template to be excluded from search

Returns:

unique template name in the context of the given client

isNameExisiting

public boolean isNameExisiting(IEntityContext ec,
 Mandant client,
 String name)

Description copied from interface: ITextbausteinDao

Checks whether the given template name exists within the given client

Specified by:

isNameExisiting in interface ITextbausteinDao

Parameters:

ec - IEntityContext to be used

client - Mandant for which to check uniqueness

name - String template name to check

Returns:

Whether the given name is unique

findAllKeywords

public Set<String> findAllKeywords(IEntityContext ec,
 Mandant mandant,
 ETextbausteinKategorie kategorie)

Description copied from interface: ITextbausteinDao

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

Specified by:

findAllKeywords in interface ITextbausteinDao

Parameters:

ec - IEntityContext to be used

mandant - Mandant to filter the templates by

kategorie - ETextbausteinKategorie to filter the templates by

Returns:

the resulting (unordered) set of keywords

getPreActionHook

protected IFCDaoActionHook<Textbaustein> getPreActionHook()

Overrides:

getPreActionHook in class GenericDao<Textbaustein>

getPostActionHook

protected IFCDaoActionHook<Textbaustein> getPostActionHook()

Overrides:

getPostActionHook in class GenericDao<Textbaustein>