Package de.xima.fc.dao.interfaces

Interface IClientFormThemeDao

All Superinterfaces:

de.xima.cmn.dao.interfaces.IAbstractDao<ClientFormTheme,Long,IEntityContext>, IGenericDao<ClientFormTheme>

All Known Implementing Classes:

ClientFormThemeDao

public interface IClientFormThemeDao
extends IGenericDao<ClientFormTheme>

Data access object for creating, updating, and deleting ClientFormTheme entities.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
List<ClientFormTheme>	allByClient(IEntityContext ec, Mandant client)	Finds all client form themes that are owned by the given client.
ClientFormTheme	byName(IEntityContext ec, Mandant client, String name)	Fetches the ClientFormTheme with the given name from the given client.
ClientFormTheme	byName(IEntityContext ec, UUID clientUuid, String name)	Fetches the ClientFormTheme with the given name from the given client.
ClientFormTheme	byUuid(IEntityContext ec, long clientId, String uuid)	Fetches the ClientFormTheme with the given UUID from the given client.
ClientFormTheme	byUuid(IEntityContext ec, long clientId, UUID uuid)	Fetches the ClientFormTheme with the given UUID from the given client.
ClientFormTheme	byUuid(IEntityContext ec, Mandant client, String uuid)	Fetches the ClientFormTheme with the given UUID from the given client.
ClientFormTheme	byUuid(IEntityContext ec, Mandant client, UUID uuid)	Fetches the ClientFormTheme with the given UUID from the given client.
ClientFormTheme	byUuid(IEntityContext ec, String clientUuid, String uuid)	Fetches the ClientFormTheme with the given UUID from the given client.
ClientFormTheme	byUuid(IEntityContext ec, String clientUuid, UUID uuid)	Fetches the ClientFormTheme with the given UUID from the given client.
ClientFormTheme	byUuid(IEntityContext ec, UUID clientUuid, String uuid)	Fetches the ClientFormTheme with the given UUID from the given client.
ClientFormTheme	byUuid(IEntityContext ec, UUID clientUuid, UUID uuid)	Fetches the ClientFormTheme with the given UUID from the given client.
String	findUniqueName(IEntityContext ec, Mandant client, String candidateName)	Finds a new unique name for a (new) given client form theme.
String	findUniqueName(IEntityContext ec, Mandant client, String candidateName, ClientFormTheme exclude)	Finds a new unique name for a (new) given client form theme.
List<ClientFormTheme>	getByParentFormTheme(IEntityContext ec, Mandant client, FormThemeReference formTheme)	Finds all form versions that are associated with the given form theme.
List<ClientFormTheme>	getByParentFormThemePlugin(IEntityContext ec, Mandant client, String formThemePluginKey)	Finds all form versions that are associated with a theme from the given form theme plugin.
List<ClientFormTheme>	getByThemeReferences(IEntityContext ec, Mandant client, Set<FormThemeReference> themeReferences)	Gets a list of client form themes from the given client that correspond to the given form theme references.
List<ClientFormThemeFile>	getFilesByFormTheme(IEntityContext ec, ClientFormTheme clientFormTheme)	Reads all files contained in the given form theme.
List<String>	themeNamesByClient(IEntityContext ec, Long clientId)	Gets the names of all form themes that are owned by the client with the given ID.
List<String>	themeNamesByClient(IEntityContext ec, UUID clientUuid)	Gets the names of all form themes that are owned by the client with the given UUID.

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 de.xima.fc.dao.interfaces.IGenericDao

count, findAll, findSingle, getEntityRefs, read

Method Detail

allByClient

List<ClientFormTheme> allByClient(IEntityContext ec,
                                  Mandant client)

Finds all client form themes that are owned by the given client.

Parameters:

ec - Entity context for accessing the database.

client - The client to which to limit the search.

Returns:

All client form themes that are owned by the given client.

byName

ClientFormTheme byName(IEntityContext ec,
                       Mandant client,
                       String name)

Fetches the ClientFormTheme with the given name from the given client.

Parameters:

ec - Entity context to use for accessing the database.

client - The client where to search for the form theme.

name - The name of the form theme to find.

Returns:

The form theme with the given name, or null if no such form theme exists.

byName

ClientFormTheme byName(IEntityContext ec,
                       UUID clientUuid,
                       String name)

Fetches the ClientFormTheme with the given name from the given client.

Parameters:

ec - Entity context to use for accessing the database.

clientUuid - The UUID of the client where to search for the form theme.

name - The name of the form theme to find.

Returns:

The form theme with the given name, or null if no such form theme exists.

byUuid

ClientFormTheme byUuid(IEntityContext ec,
                       Mandant client,
                       String uuid)

Fetches the ClientFormTheme with the given UUID from the given client.

Parameters:

ec - Entity context to use for accessing the database.

client - The client where to search for the form theme.

uuid - The UUID of the form theme to find.

Returns:

The form theme with the given UUID, or null if no such form theme exists.

byUuid

ClientFormTheme byUuid(IEntityContext ec,
                       Mandant client,
                       UUID uuid)

Fetches the ClientFormTheme with the given UUID from the given client.

Parameters:

ec - Entity context to use for accessing the database.

client - The client where to search for the form theme.

uuid - The UUID of the form theme to find.

Returns:

The form theme with the given UUID, or null if no such form theme exists.

byUuid

ClientFormTheme byUuid(IEntityContext ec,
                       long clientId,
                       String uuid)

Fetches the ClientFormTheme with the given UUID from the given client.

Parameters:

ec - Entity context to use for accessing the database.

clientId - The ID of the client where to search for the form theme.

uuid - The UUID of the form theme to find.

Returns:

The form theme with the given UUID, or null if no such form theme exists.

byUuid

ClientFormTheme byUuid(IEntityContext ec,
                       long clientId,
                       UUID uuid)

Fetches the ClientFormTheme with the given UUID from the given client.

Parameters:

ec - Entity context to use for accessing the database.

clientId - The ID of the client where to search for the form theme.

uuid - The UUID of the form theme to find.

Returns:

The form theme with the given UUID, or null if no such form theme exists.

byUuid

ClientFormTheme byUuid(IEntityContext ec,
                       UUID clientUuid,
                       String uuid)

Fetches the ClientFormTheme with the given UUID from the given client.

Parameters:

ec - Entity context to use for accessing the database.

clientUuid - The UUID of the client where to search for the form theme.

uuid - The UUID of the form theme to find.

Returns:

The form theme with the given UUID, or null if no such form theme exists.

byUuid

ClientFormTheme byUuid(IEntityContext ec,
                       UUID clientUuid,
                       UUID uuid)

Fetches the ClientFormTheme with the given UUID from the given client.

Parameters:

ec - Entity context to use for accessing the database.

clientUuid - The UUID of the client where to search for the form theme.

uuid - The UUID of the form theme to find.

Returns:

The form theme with the given UUID, or null if no such form theme exists.

byUuid

ClientFormTheme byUuid(IEntityContext ec,
                       String clientUuid,
                       String uuid)

Fetches the ClientFormTheme with the given UUID from the given client.

Parameters:

ec - Entity context to use for accessing the database.

clientUuid - The UUID of the client where to search for the form theme.

uuid - The UUID of the form theme to find.

Returns:

The form theme with the given UUID, or null if no such form theme exists.

byUuid

ClientFormTheme byUuid(IEntityContext ec,
                       String clientUuid,
                       UUID uuid)

Fetches the ClientFormTheme with the given UUID from the given client.

Parameters:

ec - Entity context to use for accessing the database.

clientUuid - The UUID of the client where to search for the form theme.

uuid - The UUID of the form theme to find.

Returns:

The form theme with the given UUID, or null if no such form theme exists.

findUniqueName

String findUniqueName(IEntityContext ec,
                      Mandant client,
                      String candidateName)

Finds a new unique name for a (new) given client form theme. The returned name is unique amongst all client form themes of the given client. The returned name is based on the given candidate name. If no theme with the candidate name exists, the candidate name is returned.

Parameters:

ec - Entity context to use for accessing the database.

client - A client with form themes to check for uniqueness.

candidateName - A candidate name to make unique.

Returns:

A unique name based on the candidate name.

findUniqueName

String findUniqueName(IEntityContext ec,
                      Mandant client,
                      String candidateName,
                      ClientFormTheme exclude)

Finds a new unique name for a (new) given client form theme. The returned name is unique amongst all client form themes of the given client. The returned name is based on the given candidate name. If no theme with the candidate name exists, the candidate name is returned.

Parameters:

ec - Entity context to use for accessing the database.

client - A client with form themes to check for uniqueness.

candidateName - A candidate name to make unique.

exclude - Optional. When given, the name of this client form theme is excluded from the uniqueness check.

Returns:

A unique name based on the candidate name.

getByParentFormTheme

List<ClientFormTheme> getByParentFormTheme(IEntityContext ec,
                                           Mandant client,
                                           FormThemeReference formTheme)

Finds all form versions that are associated with the given form theme.

Parameters:

ec - Entity context for accessing the database.

client - The client to which to limit the search. May be null to search all clients.

formTheme - The form theme reference to search for.

Returns:

All form versions that are associated with the given form theme.

getByParentFormThemePlugin

List<ClientFormTheme> getByParentFormThemePlugin(IEntityContext ec,
                                                 Mandant client,
                                                 String formThemePluginKey)

Finds all form versions that are associated with a theme from the given form theme plugin.

Parameters:

ec - Entity context for accessing the database.

client - The client to which to limit the search. May be null to search all clients.

formThemePluginKey - The key of the form theme plugin to search for.

Returns:

All form versions that are associated with a theme from the given form theme plugin.

getByThemeReferences

List<ClientFormTheme> getByThemeReferences(IEntityContext ec,
                                           Mandant client,
                                           Set<FormThemeReference> themeReferences)

Gets a list of client form themes from the given client that correspond to the given form theme references. Client form themes from different clients and form themes of different types are omitted.

Parameters:

ec - Entity context to use for accessing the database.

client - The client from which to get the client form themes.

themeReferences - The theme references to process. Only references to client form themes of the given client are considered, all other references are ignored.

Returns:

A list of client form themes that are associated with the given project.

getFilesByFormTheme

List<ClientFormThemeFile> getFilesByFormTheme(IEntityContext ec,
                                              ClientFormTheme clientFormTheme)

Reads all files contained in the given form theme.

Parameters:

ec - Entity context for accessing the database.

clientFormTheme - The form theme to read the files for.

Returns:

A list of all files from the given form theme.

themeNamesByClient

List<String> themeNamesByClient(IEntityContext ec,
                                Long clientId)

Gets the names of all form themes that are owned by the client with the given ID.

Parameters:

ec - Entity context for accessing the database.

clientId - The ID of the client to get the form themes for.

Returns:

A list of all form theme names that are owned by the client with the given ID.

themeNamesByClient

List<String> themeNamesByClient(IEntityContext ec,
                                UUID clientUuid)

Gets the names of all form themes that are owned by the client with the given UUID.

Parameters:

ec - Entity context for accessing the database.

clientUuid - The UUID of the client to get the form themes for.

Returns:

A list of all form theme names that are owned by the client with the given ID.