Package de.xima.fc.dao.interfaces

Interface IProjektDao

All Superinterfaces:

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

All Known Implementing Classes:

ProjektDao

public interface IProjektDao
extends IMandantDependentBaseDao<Projekt>

Method Summary

Modifier and Type	Method	Description
List<Projekt>	allByClient(IEntityContext ec, Mandant mandant, boolean includeTemplates)
List<Projekt>	allByClient(IEntityContext ec, Mandant client, String scope, boolean includeTemplates)
List<Projekt>	allByMandant(IEntityContext ec, Mandant mandant)	Deprecated. use allByClient(IEntityContext, Mandant, boolean)
List<Projekt>	allEditableProjects(IEntityContext ec, Benutzer benutzer, Mandant mandant, String projectScope, boolean includeTemplates)	Deprecated.
List<Projekt>	allEditableProjects(IEntityContext ec, Benutzer benutzer, Mandant mandant, String projectScope, boolean includeTemplates, de.xima.cmn.criteria.QueryCriteriaManager customQcm)	Deprecated.
List<Projekt>	allTemplatesByClient(IEntityContext ec, Mandant mandant)
List<Projekt>	allTemplatesByClient(IEntityContext ec, Mandant client, String scope)
List<Projekt>	allVisibleProjects(IEntityContext ec, Benutzer benutzer, Mandant mandant, String projectScope, boolean includeTemplates)	Deprecated.
List<Projekt>	allVisibleProjects(IEntityContext ec, Benutzer benutzer, Mandant mandant, String projectScope, boolean includeTemplates, de.xima.cmn.criteria.QueryCriteriaManager customQcm)	Deprecated.
de.xima.cmn.criteria.QueryCriteriaManager	allVisibleProjectsQcm(IEntityContext ec, Benutzer user, Mandant client, String projectScope, boolean includeTemplates)	Deprecated.
String	findUniqueName(IEntityContext ec, Mandant client, String candidate, Projekt exclude)	Returns a name that is not taken by another Projekt in the given client other than the excluded data source.
String	findUniqueTitle(IEntityContext ec, Mandant client, String candidate, Projekt exclude)	Returns a title that is not taken by another Projekt in the given client other than the excluded data source.
List<Projekt>	getAccessableProjects(IEntityContext ec, IUser user, Mandant client)	Returns all projects which are editable or visible by the user groups of the user in the given client.
Projekt	getByUUID(IEntityContext ec, Mandant client, String uuid)	Gets a project by its UUID.
Projekt	getByUUID(IEntityContext ec, Mandant client, UUID uuid)	Gets a project by its UUID.
Projekt	getByUUID(IEntityContext ec, Long clientId, UUID uuid)	Gets a project by its UUID.
Projekt	getByUUID(IEntityContext ec, UUID clientUuid, UUID uuid)	Gets a project by its UUID.
byte[]	getPreviewImage(IEntityContext ec, Projekt project)
String	getPreviewImageVersion(IEntityContext ec, Projekt project)
Set<Long>	getProjectsWithPreviewImage(IEntityContext ec, Mandant client)
List<Projekt>	getProjektByEditorBenutzer(IEntityContext ec, Benutzer benutzer, Mandant mandant)	Deprecated.
List<Projekt>	getProjektByEditorBenutzer(IEntityContext ec, Benutzer benutzer, Mandant mandant, String projectScope)	Deprecated.
boolean	isActivationAllowed(IEntityContext ec, Projekt projekt)
boolean	isEditingAllowed(IEntityContext ec, Projekt p, Benutzer ben)	Deprecated.
boolean	isFsAllowed(IEntityContext ec, Projekt p, FrontendServer fs)
boolean	isNameExisiting(IEntityContext ec, Mandant client, String name)	Returns whether or not the given project name exists within the given client
boolean	isTitleExisiting(IEntityContext ec, Mandant client, String name)	Returns whether or not the given project title exists within the given client
boolean	isZugriffsberechtigt(IEntityContext ec, Projekt p, Benutzer ben)	Deprecated.
void	updatePreviewImage(IEntityContext ec, Projekt project, byte[] data)

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

getByUUID

Projekt getByUUID(IEntityContext ec,
                  UUID clientUuid,
                  UUID uuid)

Gets a project by its UUID. The project must be in the given client.

Parameters:

ec - Entity context for accessing the database.

clientUuid - UUID of the client to which the project must belong.

uuid - UUID of the project to get.

Returns:

The project with the given UUID in the given client, or null if no such project exists.

getByUUID

Projekt getByUUID(IEntityContext ec,
                  Long clientId,
                  UUID uuid)

Gets a project by its UUID. The project must be in the given client.

Parameters:

ec - Entity context for accessing the database.

clientId - ID of the client to which the project must belong.

uuid - UUID of the project to get.

Returns:

The project with the given UUID in the given client, or null if no such project exists.

getByUUID

Projekt getByUUID(IEntityContext ec,
                  Mandant client,
                  String uuid)

Gets a project by its UUID. The project must be in the given client.

Parameters:

ec - Entity context for accessing the database.

client - The client to which the project must belong.

uuid - UUID of the project to get.

Returns:

The project with the given UUID in the given client, or null if no such project exists.

getByUUID

Projekt getByUUID(IEntityContext ec,
                  Mandant client,
                  UUID uuid)

Gets a project by its UUID. The project must be in the given client.

Parameters:

ec - Entity context for accessing the database.

client - The client to which the project must belong.

uuid - UUID of the project to get.

Returns:

The project with the given UUID in the given client, or null if no such project exists.

isActivationAllowed

boolean isActivationAllowed(IEntityContext ec,
                            Projekt projekt)

isFsAllowed

boolean isFsAllowed(IEntityContext ec,
                    Projekt p,
                    FrontendServer fs)

getPreviewImage

byte[] getPreviewImage(IEntityContext ec,
                       Projekt project)

getProjectsWithPreviewImage

Set<Long> getProjectsWithPreviewImage(IEntityContext ec,
                                      Mandant client)

Parameters:

ec - Entity context for accessing the database.

client - Client to which to limit the search. May be null, in which case no restriction is applied.

Returns:

A list of all IDs of projects for which a preview image is available.

allByClient

List<Projekt> allByClient(IEntityContext ec,
                          Mandant mandant,
                          boolean includeTemplates)

allByClient

List<Projekt> allByClient(IEntityContext ec,
                          Mandant client,
                          String scope,
                          boolean includeTemplates)

allTemplatesByClient

List<Projekt> allTemplatesByClient(IEntityContext ec,
                                   Mandant mandant)

allTemplatesByClient

List<Projekt> allTemplatesByClient(IEntityContext ec,
                                   Mandant client,
                                   String scope)

findUniqueName

String findUniqueName(IEntityContext ec,
                      Mandant client,
                      String candidate,
                      Projekt exclude)

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

Parameters:

ec - IEntityContext to be used

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

candidate - String project name candiate to be made unique

exclude - Projekt project to be excluded from search

Returns:

unique project name in the context of the given client

Since:

6.6.0

findUniqueTitle

String findUniqueTitle(IEntityContext ec,
                       Mandant client,
                       String candidate,
                       Projekt exclude)

Returns a title that is not taken by another Projekt in the given client other than the excluded data source. An index will be added to the candidate if necessary.

Parameters:

ec - IEntityContext to be used

client - Mandant for which a unique project title should be generated

candidate - String project title candiate to be made unique

exclude - Projekt project to be excluded from search

Returns:

unique project title in the context of the given client

Since:

6.6.0

isNameExisiting

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

Returns whether or not the given project name exists within the given client

Parameters:

ec - IEntityContext to be used

client - Mandant for which to check uniqueness

name - Project name to check

Returns:

whether or not the given name is unique

Since:

6.6.0

isTitleExisiting

boolean isTitleExisiting(IEntityContext ec,
                         Mandant client,
                         String name)

Returns whether or not the given project title exists within the given client

Parameters:

ec - IEntityContext to be used

client - Mandant for which to check uniqueness

name - Project title to check

Returns:

whether or not the given title is unique

Since:

6.6.0

updatePreviewImage

void updatePreviewImage(IEntityContext ec,
                        Projekt project,
                        byte[] data)

allByMandant

@Deprecated
List<Projekt> allByMandant(IEntityContext ec,
                           Mandant mandant)

Deprecated.

use allByClient(IEntityContext, Mandant, boolean)

getPreviewImageVersion

String getPreviewImageVersion(IEntityContext ec,
                              Projekt project)

Parameters:

ec - Entity context for accessing the database.

project - Project for which to find the preview image.

Returns:

The current (locking) version of the preview image.

getAccessableProjects

List<Projekt> getAccessableProjects(IEntityContext ec,
                                    IUser user,
                                    Mandant client)

Returns all projects which are editable or visible by the user groups of the user in the given client.

Parameters:

ec - IEntityContext to be used

user - IUser who has the user groups

client - Mandant containing the user groups

Returns:

all projects which are visible or editable for the user in the given client

Since:

8.0.0

isZugriffsberechtigt

@Deprecated
boolean isZugriffsberechtigt(IEntityContext ec,
                             Projekt p,
                             Benutzer ben)

Deprecated.

isEditingAllowed

@Deprecated
boolean isEditingAllowed(IEntityContext ec,
                         Projekt p,
                         Benutzer ben)

Deprecated.

getProjektByEditorBenutzer

@Deprecated
List<Projekt> getProjektByEditorBenutzer(IEntityContext ec,
                                         Benutzer benutzer,
                                         Mandant mandant)

Deprecated.

getProjektByEditorBenutzer

@Deprecated
List<Projekt> getProjektByEditorBenutzer(IEntityContext ec,
                                         Benutzer benutzer,
                                         Mandant mandant,
                                         String projectScope)

Deprecated.

allVisibleProjects

@Deprecated
List<Projekt> allVisibleProjects(IEntityContext ec,
                                 Benutzer benutzer,
                                 Mandant mandant,
                                 String projectScope,
                                 boolean includeTemplates)

Deprecated.

allVisibleProjects

@Deprecated
List<Projekt> allVisibleProjects(IEntityContext ec,
                                 Benutzer benutzer,
                                 Mandant mandant,
                                 String projectScope,
                                 boolean includeTemplates,
                                 de.xima.cmn.criteria.QueryCriteriaManager customQcm)

Deprecated.

allEditableProjects

@Deprecated
List<Projekt> allEditableProjects(IEntityContext ec,
                                  Benutzer benutzer,
                                  Mandant mandant,
                                  String projectScope,
                                  boolean includeTemplates)

Deprecated.

allEditableProjects

@Deprecated
List<Projekt> allEditableProjects(IEntityContext ec,
                                  Benutzer benutzer,
                                  Mandant mandant,
                                  String projectScope,
                                  boolean includeTemplates,
                                  de.xima.cmn.criteria.QueryCriteriaManager customQcm)

Deprecated.

allVisibleProjectsQcm

@Deprecated
de.xima.cmn.criteria.QueryCriteriaManager allVisibleProjectsQcm(IEntityContext ec,
                                                                Benutzer user,
                                                                Mandant client,
                                                                String projectScope,
                                                                boolean includeTemplates)

Deprecated.