de.xima.fc.api.entity

Class ProjektAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<Projekt>

de.xima.fc.api.entity.ProjektAPI

public class ProjektAPI
extends AEntityAPI<Projekt>

API-Klassse zur Manipulation von Projekt-Entitäten

Author:

Michael Kohlsche

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor and Description
ProjektAPI()

Method Summary

Modifier and Type	Method and Description
Projekt	addProjektRessource(UserContext uc, Projekt projekt, ProjektRessource ressource)
Projekt	copy(UserContext uc, Projekt projekt, int id, int fvId)
List<Projekt>	getAllByMandant(UserContext uc, Mandant mandant) Methode zum Ermitteln aller Projekte eines Mandanten
List<Projekt>	getAllByMandantAndStatus(UserContext uc, Mandant mandant, Boolean isOnline) Methode zum Ermitteln aller Projekte eines Mandanten und dessen Online-Status
Projekt	getByName(UserContext uc, Integer mandantId, String name) Methode zum Ermitteln eines Projektes anhand seines Namens.
FormVersion	getCurrentFormVersion(UserContext uc, Projekt projekt, FrontendServer fs) Methode zum Ermitteln der Aktuellen FormVersion eines Projekts.
List<BenutzerGruppe>	getEditorGruppen(UserContext uc, Integer projektId) Methode zum Ermitteln der BenutzerGruppen die Berechtigt sind das Projekt zu bearbeiten.
Projekt	importProjekt(UserContext uc, Mandant mandant, byte[] bytes, String name, String beschreibung, String title) Methode zum importieren eines Projekts für einen Mandanten
boolean	isActivationAllowed(UserContext uc, Projekt projekt)
boolean	isFsAllowed(UserContext uc, Projekt project, FrontendServer fs) Methode zum Testen, ob das Projekt über den FrontendServer aufgerufen werden darf.
Boolean	isZugriffsberechtigt(UserContext uc, Projekt projekt, Benutzer benutzer) Methode zum Ermitteln ob ein Benutzer auf ein Projekt zugreifen darf
boolean	isZugriffsbeschraenkt(UserContext uc, Projekt projekt) Methode zum Ermitteln ob ein Projekt zugriffsbeschränkt ist
Projekt	update(UserContext uc, Projekt entity) Methode zum Aktualisieren einer Entität.
Projekt[]	update(UserContext uc, Projekt[] entities) Methode zum Aktualisieren mehrerer Entitäten.

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, getAll, getAllBy, getBy, getById, resultTotalCount

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjektAPI

public ProjektAPI()

Method Detail

getByName

public Projekt getByName(UserContext uc,
                         Integer mandantId,
                         String name)

Methode zum Ermitteln eines Projektes anhand seines Namens.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandantId - ID des Mandanten für welchen das Projekt ermittelt werden soll

name - String der Name des gesuchten Projekts

Returns:

Projekt welches gefunden wurde @since 2.4.3

getEditorGruppen

public List<BenutzerGruppe> getEditorGruppen(UserContext uc,
                                             Integer projektId)

Methode zum Ermitteln der BenutzerGruppen die Berechtigt sind das Projekt zu bearbeiten.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandantId - ID des Mandanten für welchen das Projekt ermittelt werden soll

name - String der Name des gesuchten Projekts

Returns:

Projekt welches gefunden wurde @since 2.4.3

getCurrentFormVersion

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

Methode zum Ermitteln der Aktuellen FormVersion eines Projekts.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

projekt - Projekt dessen FormVersion ermittelt werden soll

fs - FrontendServer der Frontendserver welcher die Daten erhalten möchte

Returns:

die aktuell aktivierte FormVersion des Projekts @since 2.4.3

isZugriffsberechtigt

public Boolean isZugriffsberechtigt(UserContext uc,
                                    Projekt projekt,
                                    Benutzer benutzer)

Methode zum Ermitteln ob ein Benutzer auf ein Projekt zugreifen darf

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

projekt - gegen welchen die Zugriffsberechtigung geprüft wird

benutzer - dessen Zugriffsberechtigung geprüft wird

Returns:

true wenn Benutzer auf das Projekt zugreifen darf @since 2.4.3

isZugriffsbeschraenkt

public boolean isZugriffsbeschraenkt(UserContext uc,
                                     Projekt projekt)

Methode zum Ermitteln ob ein Projekt zugriffsbeschränkt ist

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

projekt - welches geprüft werden soll

Returns:

true wenn ein Projekt zugriffsbeschränkt ist @since 2.4.3

getAllByMandant

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

Methode zum Ermitteln aller Projekte eines Mandanten

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandant - dessen Projekte ermittelt werden sollen

Returns:

List mit Projekten @ wenn ein Fehler auftritt

Since:

2.4.3

getAllByMandantAndStatus

public List<Projekt> getAllByMandantAndStatus(UserContext uc,
                                              Mandant mandant,
                                              Boolean isOnline)

Methode zum Ermitteln aller Projekte eines Mandanten und dessen Online-Status

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandant - dessen Projekte ermittelt werden sollen

isOnline - true wenn nur freigegbene Projekte angezeigt werden sollen

Returns:

List mit Projekten @ wenn ein Fehler auftritt

Since:

2.4.3

addProjektRessource

public Projekt addProjektRessource(UserContext uc,
                                   Projekt projekt,
                                   ProjektRessource ressource)

importProjekt

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

Methode zum importieren eines Projekts für einen Mandanten

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandant - dem das Projekt zugeordnet werden soll

bytes - des Projektarchivs

name - Projektname insofern dieser anders zum im Archiv angegebenen Namen sein soll (ansonsten null)

beschreibung - Projektbeschreibung insofern diese anders zum im Archiv angegebener Beschreibung sein soll (ansonsten null)

title - Projekttitle insofern dieser anders zum im Archiv angegebenen Titel sein soll (ansonsten null)

Returns:

das importierte Projekt oder null wenn der Import nicht erfolgreich war @ Wenn ein Fehler beim Anlegen auftritt

Throws:

IOException

Exception

Since:

2.4.3

isActivationAllowed

public boolean isActivationAllowed(UserContext uc,
                                   Projekt projekt)

isFsAllowed

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

Methode zum Testen, ob das Projekt über den FrontendServer aufgerufen werden darf.

Parameters:

uc -

project -

fs -

Returns:

update

public Projekt update(UserContext uc,
                      Projekt entity)

Description copied from class: AEntityAPI

Methode zum Aktualisieren einer Entität.

Overrides:

update in class AEntityAPI<Projekt>

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

entity - die zu aktualisierende Entität

Returns:

die aktualisierte Entität @

update

public Projekt[] update(UserContext uc,
                        Projekt[] entities)

Description copied from class: AEntityAPI

Methode zum Aktualisieren mehrerer Entitäten.

Overrides:

update in class AEntityAPI<Projekt>

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

entities - ein Array der zu aktualisierenden Entitäten

Returns:

Array mit den aktuelisierten Entitäten @

copy

public Projekt copy(UserContext uc,
                    Projekt projekt,
                    int id,
                    int fvId)
             throws Exception

Throws:

Exception