Class ProjektHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.entity.GenericHandler

de.xima.fc.handler.entity.ProjektHandler

All Implemented Interfaces:

IAPIHandler, IGenericHandler, IProjektHandler, Serializable

public class ProjektHandler
extends GenericHandler
implements IProjektHandler

The Class ProjektHandler.

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields inherited from class GenericHandler

LOG

Constructor Summary

Constructors

Constructor	Description
ProjektHandler()

Method Summary

Modifier and Type	Method	Description
Projekt	addProjektRessource(UserContext uc, long projektId, long ressourceId)
Projekt	copy(UserContext uc, Projekt projekt, long sourceProjectId, long formVersionId, long workflowVersionId)
List<BenutzerGruppe>	getAccessGroups(UserContext uc, Projekt project)
Projekt	getActiveByUserPortalAndFrontendServer(UserContext uc, UUID userPortalUuid, UUID formUuid, Long frontendServerId)
Projekt	getActiveByUUIDAndFrontendServer(UserContext uc, UUID clientUuid, UUID formUuid, Long frontendServerId)
List<Projekt>	getAllByClient(UserContext uc, Mandant mandant, boolean includeTemplates)
List<Projekt>	getAllByClient(UserContext uc, Mandant mandant, String scope, boolean includeTemplates)
List<Projekt>	getAllByEditorUser(UserContext uc, Benutzer editor, Mandant client, String projectScope)	Deprecated.
List<Projekt>	getAllByMandant(UserContext uc, Mandant mandant)	Deprecated. use getAllByClient(UserContext, Mandant, boolean)
PagedResult<Projekt>	getAllByUserPortal(UserContext uc, UserPortal portal, int page, int pageSize)	Deprecated. use getProjectsPage(UserContext, PageQuery, ProjectsPageQuery, boolean)
List<Projekt>	getAllTemplatesByClient(UserContext uc, Mandant client)
List<Projekt>	getAllTemplatesByClient(UserContext uc, Mandant client, String scope)
Projekt	getByUUID(UserContext uc, Mandant client, String uuid)	Gets a project by its UUID.
Projekt	getByUUID(UserContext uc, Mandant client, UUID uuid)	Gets a project by its UUID.
Projekt	getByUUID(UserContext uc, UUID clientUuid, UUID uuid)	Gets a project by its UUID.
FormVersion	getCurrentFormVersion(UserContext uc, Projekt projekt, FrontendServer fs)	Gets the current form version.
Map<String,String>	getCustomAttributes(UserContext uc, Projekt project)
Projekt	getInitializedById(UserContext uc, Long projectId)	Reads the project by the given ID and initializes it.
int	getProjectsCount(UserContext uc, ProjectsPageQuery filter)	Returns the number of projects for the given page request and filter.
PagedResult<Projekt>	getProjectsPage(UserContext uc, PageQuery page, ProjectsPageQuery filter, boolean skipCount)	Returns all projects enabled for the given user portal.
ProjectFile	getUserPortalProjectFile(UserContext uc, UUID portalUuid, UUID clientUuid, UUID projectUuid, UUID fileUuid)	Returns the project file with the given file UUID in the context of the user portal with the given UUID.
Projekt	importProjekt(UserContext uc, Mandant mandant, byte[] bytes, String name, String beschreibung, String title)
boolean	isActivationAllowed(UserContext uc, Projekt projekt)
Boolean	isEditingAllowed(UserContext uc, Projekt projekt, Benutzer ben)	Deprecated.
boolean	isFsAllowed(UserContext uc, Projekt project, FrontendServer fs)	Checks on whether the project can be accessed via the frontend server.
Boolean	isZugriffsberechtigt(UserContext uc, Projekt projekt, Benutzer ben)	Deprecated.
Boolean	isZugriffsbeschraenkt(UserContext uc, Projekt projekt)

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

ProjektHandler

public ProjektHandler()

Method Details

getCurrentFormVersion

public FormVersion getCurrentFormVersion(UserContext uc,
 Projekt projekt,
 FrontendServer fs)

Description copied from interface: IProjektHandler

Gets the current form version.

Specified by:

getCurrentFormVersion in interface IProjektHandler

Parameters:

uc - the uc

projekt - the projekt

fs - the FrontendServer

Returns:

the current form version

getAccessGroups

public List<BenutzerGruppe> getAccessGroups(UserContext uc,
 Projekt project)

Specified by:

getAccessGroups in interface IProjektHandler

getProjectsPage

public PagedResult<Projekt> getProjectsPage(UserContext uc,
 PageQuery page,
 ProjectsPageQuery filter,
 boolean skipCount)

Description copied from interface: IProjektHandler

Returns all projects enabled for the given user portal. Sorted by their display name.

Specified by:

getProjectsPage in interface IProjektHandler

Parameters:

uc - user context for database transactions.

page - page request defining the page and page size.

filter - project page request defining the user portal, filters.

skipCount - The number of rows to skip.

Returns:

all projects enabled for the given user portal.

getProjectsCount

public int getProjectsCount(UserContext uc,
 ProjectsPageQuery filter)

Description copied from interface: IProjektHandler

Returns the number of projects for the given page request and filter.

Specified by:

getProjectsCount in interface IProjektHandler

Parameters:

uc - user context for database transactions.

filter - page request defining the user portal, filters.

Returns:

the number of projects enabled for the given user portal.

getActiveByUserPortalAndFrontendServer

public Projekt getActiveByUserPortalAndFrontendServer(UserContext uc,
 UUID userPortalUuid,
 UUID formUuid,
 Long frontendServerId)

Specified by:

getActiveByUserPortalAndFrontendServer in interface IProjektHandler

getActiveByUUIDAndFrontendServer

public Projekt getActiveByUUIDAndFrontendServer(UserContext uc,
 UUID clientUuid,
 UUID formUuid,
 Long frontendServerId)

Specified by:

getActiveByUUIDAndFrontendServer in interface IProjektHandler

isEditingAllowed

@Deprecated
public Boolean isEditingAllowed(UserContext uc,
 Projekt projekt,
 Benutzer ben)

Deprecated.

Specified by:

isEditingAllowed in interface IProjektHandler

Parameters:

uc - Current user context.

projekt - Project for which to check if the user may edit it.

ben - User to check.

Returns:

Whether the user groups of the user allow editing the given form (project). Note that there may be other restrictions from the user's role etc that apply.

isZugriffsbeschraenkt

public Boolean isZugriffsbeschraenkt(UserContext uc,
 Projekt projekt)

Specified by:

isZugriffsbeschraenkt in interface IProjektHandler

isZugriffsberechtigt

@Deprecated
public Boolean isZugriffsberechtigt(UserContext uc,
 Projekt projekt,
 Benutzer ben)

Deprecated.

Specified by:

isZugriffsberechtigt in interface IProjektHandler

importProjekt

public Projekt importProjekt(UserContext uc,
 Mandant mandant,
 byte[] bytes,
 String name,
 String beschreibung,
 String title)
                      throws Exception

Specified by:

importProjekt in interface IProjektHandler

Throws:

Exception

addProjektRessource

public Projekt addProjektRessource(UserContext uc,
 long projektId,
 long ressourceId)

Specified by:

addProjektRessource in interface IProjektHandler

getInitializedById

public Projekt getInitializedById(UserContext uc,
 Long projectId)

Description copied from interface: IProjektHandler

Reads the project by the given ID and initializes it.

Specified by:

getInitializedById in interface IProjektHandler

Parameters:

uc - UserContext to use for DB transaction

projectId - ID of the project

Returns:

the initialized project

getUserPortalProjectFile

public ProjectFile getUserPortalProjectFile(UserContext uc,
 UUID portalUuid,
 UUID clientUuid,
 UUID projectUuid,
 UUID fileUuid)

Description copied from interface: IProjektHandler

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

Specified by:

getUserPortalProjectFile in interface IProjektHandler

Parameters:

uc - User context for accessing the database.

portalUuid - UUID of the user portal (context).

clientUuid - UUID of the client (context).

projectUuid - UUID of the project.

fileUuid - UUID of the project file.

Returns:

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

getAllByClient

public List<Projekt> getAllByClient(UserContext uc,
 Mandant mandant,
 boolean includeTemplates)

Specified by:

getAllByClient in interface IProjektHandler

getAllByClient

public List<Projekt> getAllByClient(UserContext uc,
 Mandant mandant,
 String scope,
 boolean includeTemplates)

Specified by:

getAllByClient in interface IProjektHandler

getAllTemplatesByClient

public List<Projekt> getAllTemplatesByClient(UserContext uc,
 Mandant client)

Specified by:

getAllTemplatesByClient in interface IProjektHandler

getAllTemplatesByClient

public List<Projekt> getAllTemplatesByClient(UserContext uc,
 Mandant client,
 String scope)

Specified by:

getAllTemplatesByClient in interface IProjektHandler

getAllByEditorUser

@Deprecated
public List<Projekt> getAllByEditorUser(UserContext uc,
 Benutzer editor,
 Mandant client,
 String projectScope)

Deprecated.

Description copied from interface: IProjektHandler

Gets all projects where the given user is editor of

Specified by:

getAllByEditorUser in interface IProjektHandler

Parameters:

uc - UserContext

editor - Editor user of the projects

client - Mandant client of the projects

projectScope - the scope of the projects to load

Returns:

List of Projekts

copy

public Projekt copy(UserContext uc,
 Projekt projekt,
 long sourceProjectId,
 long formVersionId,
 long workflowVersionId)
             throws Exception

Specified by:

copy in interface IProjektHandler

Throws:

Exception

isActivationAllowed

public boolean isActivationAllowed(UserContext uc,
 Projekt projekt)

Specified by:

isActivationAllowed in interface IProjektHandler

isFsAllowed

public boolean isFsAllowed(UserContext uc,
 Projekt project,
 FrontendServer fs)

Description copied from interface: IProjektHandler

Checks on whether the project can be accessed via the frontend server.

Specified by:

isFsAllowed in interface IProjektHandler

Parameters:

uc - the UserContext to use

project - the project

fs - the frontendserver

Returns:

Boolean of the Projekt is allowed on this FrontendServer

getByUUID

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

Description copied from interface: IProjektHandler

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

Specified by:

getByUUID in interface IProjektHandler

Parameters:

uc - User context of the user who wishes to get the project.

client - The client who owns the project.

uuid - UUID of the project.

Returns:

The project or null if it does not exist.

getByUUID

public Projekt getByUUID(UserContext uc,
 UUID clientUuid,
 UUID uuid)

Description copied from interface: IProjektHandler

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

Specified by:

getByUUID in interface IProjektHandler

Parameters:

uc - User context of the user who wishes to get the project.

clientUuid - UUID of the client.

uuid - UUID of the project.

Returns:

The project or null if it does not exist.

getByUUID

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

Description copied from interface: IProjektHandler

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

Specified by:

getByUUID in interface IProjektHandler

Parameters:

uc - User context of the user who wishes to get the project.

client - The client who owns the project.

uuid - UUID of the project.

Returns:

The project or null if it does not exist.

getCustomAttributes

public Map<String,String> getCustomAttributes(UserContext uc,
 Projekt project)

Specified by:

getCustomAttributes in interface IProjektHandler

getAllByMandant

@Deprecated
public List<Projekt> getAllByMandant(UserContext uc,
 Mandant mandant)

Deprecated.

use getAllByClient(UserContext, Mandant, boolean)

Specified by:

getAllByMandant in interface IProjektHandler

Parameters:

uc - the UserContext to use

mandant - the client

Returns:

List of Projekts

getAllByUserPortal

@Deprecated
public PagedResult<Projekt> getAllByUserPortal(UserContext uc,
 UserPortal portal,
 int page,
 int pageSize)

Deprecated.

use getProjectsPage(UserContext, PageQuery, ProjectsPageQuery, boolean)

Description copied from interface: IProjektHandler

Returns all projects enabled for the given user portal. Sorted by the name of a project.

Specified by:

getAllByUserPortal in interface IProjektHandler

Parameters:

uc - user context for database transactions.

portal - to get the projects for.

page - to get.

pageSize - size of the page to get.

Returns:

all projects enabled for the given user portal.