de.xima.fc.api.entity

Class VorgangAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.VorgangAPI

public class VorgangAPI
extends AEntityAPI<Vorgang>

API-Klassse zur Manipulation von Vorgang-Entitäten

Author:

Michael Kohlsche

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor and Description
VorgangAPI()

Method Summary

Methods

Modifier and Type	Method and Description
Vorgang	addAttachment(UserContext uc, Vorgang vorgang, Attachment att) Methode zum Hinzufügen eines Attachments an einen Vorgang
List<Vorgang>	getAllByBenutzer(UserContext uc, Benutzer benutzer) Methode zum Ermitteln aller Vorgänge die dem Benutzer zugeordnet sind.
List<Vorgang>	getAllByPostfach(UserContext uc, Postfach postfach) Methode zum Ermitteln aller Vorgänge eines Postfachs
Map<String,String>	getCustomAttributes(UserContext uc, Vorgang v) Methode zum Ermitteln aller CustomAttribute eines Vorgangs
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt projekt, Postfach postfach, de.xima.cmn.criteria.QueryCriteriaManager qcm) Deprecated. use getVorgaengeData(UserContext, Projekt, Postfach, QueryCriteriaManager, EProjectSpecificDBTable)
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt projekt, Postfach postfach, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType) Methode zum Ermitteln von Vorgangsdaten anhand eines Projektes und eines Postfaches
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt projekt, de.xima.cmn.criteria.QueryCriteriaManager qcm) Deprecated. use getVorgaengeData(UserContext, Projekt, QueryCriteriaManager, EProjectSpecificDBTable)
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt projekt, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType) Methode zum Ermitteln von Vorgangsdaten anhand eines Projektes
long	getVorgaengeDataTotalCount(UserContext uc, Projekt projekt, Postfach postfach, de.xima.cmn.criteria.QueryCriteriaManager qcm) Deprecated. use getVorgaengeDataTotalCount(UserContext, Projekt, Postfach, QueryCriteriaManager, EProjectSpecificDBTable)
long	getVorgaengeDataTotalCount(UserContext uc, Projekt projekt, Postfach postfach, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType) Methode zum Ermitteln der Gesamtanzahl aller Vorgangsdaten der Vorgänge eines Projekts und Postfachs
long	getVorgaengeDataTotalCount(UserContext uc, Projekt projekt, de.xima.cmn.criteria.QueryCriteriaManager qcm) Deprecated. use getVorgaengeDataTotalCount(UserContext, Projekt, QueryCriteriaManager, EProjectSpecificDBTable)
long	getVorgaengeDataTotalCount(UserContext uc, Projekt projekt, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType) Methode zum Ermitteln der Gesamtanzahl aller Vorgangsdaten der Vorgänge eines Projekts
Vorgang	getVorgangBy(UserContext uc, Projekt projekt, String vorgangProzessID) Methode zum Ermitteln eines Vorgangs anhand der Prozess-ID und des Projekts
Vorgang	getVorgangBy(UserContext uc, String vorgangProzessID) Methode zum Ermitteln eines Vorgangs anhand der Prozess-ID
ExtendedEntityModel<Vorgang>	getVorgangsData(UserContext uc, Projekt pro, Vorgang v, de.xima.cmn.criteria.QueryCriteriaManager qcm) Deprecated. use getVorgangsData(UserContext, Projekt, Vorgang, QueryCriteriaManager, EProjectSpecificDBTable)
ExtendedEntityModel<Vorgang>	getVorgangsData(UserContext uc, Projekt pro, Vorgang v, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType) Methode zum Ermitteln von Vorgangsdaten eines konkreten Vorgangs eines Projektes
ExtendedEntityModel<Vorgang>	getVorgangsData(UserContext uc, String prozessId, de.xima.cmn.criteria.QueryCriteriaManager qcm) Deprecated. use getVorgangsData(UserContext, String, QueryCriteriaManager, EProjectSpecificDBTable)
ExtendedEntityModel<Vorgang>	getVorgangsData(UserContext uc, String prozessId, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType) Methode zum Ermitteln von Vorgangsdaten eines konkreten Vorgangs anhand einer Prozess-ID.

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

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

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

VorgangAPI

public VorgangAPI()

Method Detail

getVorgangBy

public Vorgang getVorgangBy(UserContext uc,
                   String vorgangProzessID)

Methode zum Ermitteln eines Vorgangs anhand der Prozess-ID

Parameters:

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

vorgangProzessID - String die Prozess-ID des Vorgangs

Returns:

Vorgang der gesuchte Vorgang @since 2.4.3

getVorgangBy

public Vorgang getVorgangBy(UserContext uc,
                   Projekt projekt,
                   String vorgangProzessID)

Methode zum Ermitteln eines Vorgangs anhand der Prozess-ID und des Projekts

Parameters:

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

projekt - Projekt des gesuchten Vorgangs

vorgangProzessID - String die Prozess-ID des Vorgangs

Returns:

Vorgang der gesuchte Vorgang @since 2.4.3

addAttachment

public Vorgang addAttachment(UserContext uc,
                    Vorgang vorgang,
                    Attachment att)

Methode zum Hinzufügen eines Attachments an einen Vorgang

Parameters:

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

vorgang - der Vorgang, dem das Attachment hinzugefügt werden soll

att - das hinzuzufügende Attachment

Returns:

der Vorgang, dem das Attachment hinzugefügt wurde

getAllByBenutzer

public List<Vorgang> getAllByBenutzer(UserContext uc,
                             Benutzer benutzer)

Methode zum Ermitteln aller Vorgänge die dem Benutzer zugeordnet sind. Die Vorgänge werden über die BenutzerGruppen und dessen Postfacher ermittelt.

Parameters:

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

benutzer - Benutzer, welcher den Vorgängen zugewiesen ist

Returns:

Liste von Vorgangen @since 2.4.3

getAllByPostfach

public List<Vorgang> getAllByPostfach(UserContext uc,
                             Postfach postfach)

Methode zum Ermitteln aller Vorgänge eines Postfachs

Parameters:

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

postfach - Postfach, dessen Vorgänge ermittelt werden sollen

Returns:

Liste von Vorgangen @since 2.4.5

getVorgaengeData

public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc,
                                                  Projekt projekt,
                                                  Postfach postfach,
                                                  de.xima.cmn.criteria.QueryCriteriaManager qcm,
                                                  EProjectSpecificDBTable tableType)

Methode zum Ermitteln von Vorgangsdaten anhand eines Projektes und eines Postfaches

Parameters:

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

projekt - das Projekt dem die Vorgänge zugeordnet sind

postfach - das Postfach in dem die Vorgänge liegen

qcm - QueryCriteriaManager mit spezifischen Filterparametern

tableType - gibt an aus welcher Tabelle die Daten ermittelt werden sollen
Bei Auswahl des TabellenTyps EProjectSpecificDBTable.DATA_INBOX kann der Parameter postfach mit null belegt werden

Returns:

List mit generischen Objekten von Vorgangsdaten

Since:

4.3.2

getVorgaengeData

public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc,
                                                  Projekt projekt,
                                                  de.xima.cmn.criteria.QueryCriteriaManager qcm,
                                                  EProjectSpecificDBTable tableType)

Methode zum Ermitteln von Vorgangsdaten anhand eines Projektes

Parameters:

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

projekt - das Projekt dem die Vorgänge zugeordnet sind

qcm - QueryCriteriaManager mit spezifischen Filterparametern

tableType - gibt an aus welcher Tabelle die Daten ermittelt werden sollen

Returns:

List mit generischen Objekten von Vorgangsdaten

Since:

4.3.2

getVorgaengeData

@Deprecated
public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc,
                                                             Projekt projekt,
                                                             de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated. use getVorgaengeData(UserContext, Projekt, QueryCriteriaManager, EProjectSpecificDBTable)

getVorgaengeData

@Deprecated
public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc,
                                                             Projekt projekt,
                                                             Postfach postfach,
                                                             de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated. use getVorgaengeData(UserContext, Projekt, Postfach, QueryCriteriaManager, EProjectSpecificDBTable)

getVorgangsData

public ExtendedEntityModel<Vorgang> getVorgangsData(UserContext uc,
                                           String prozessId,
                                           de.xima.cmn.criteria.QueryCriteriaManager qcm,
                                           EProjectSpecificDBTable tableType)

Methode zum Ermitteln von Vorgangsdaten eines konkreten Vorgangs anhand einer Prozess-ID.

Parameters:

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

prozessId - die Prozess-ID des Vorgangs dessen Daten geladen werden sollen

qcm - QueryCriteriaManager mit spezifischen Filterparametern

tableType - gibt an aus welcher Tabelle die Daten ermittelt werden sollen

Returns:

generisches Objekt von Vorgangsdaten

Since:

4.3.2

getVorgangsData

@Deprecated
public ExtendedEntityModel<Vorgang> getVorgangsData(UserContext uc,
                                                      String prozessId,
                                                      de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated. use getVorgangsData(UserContext, String, QueryCriteriaManager, EProjectSpecificDBTable)

getVorgangsData

public ExtendedEntityModel<Vorgang> getVorgangsData(UserContext uc,
                                           Projekt pro,
                                           Vorgang v,
                                           de.xima.cmn.criteria.QueryCriteriaManager qcm,
                                           EProjectSpecificDBTable tableType)

Methode zum Ermitteln von Vorgangsdaten eines konkreten Vorgangs eines Projektes

Parameters:

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

pro - das Projekt zu dem der Vorgang gehört

v - der Vorgang dessen Daten ermittelt werden sollen

qcm - QueryCriteriaManager mit spezifischen Filterparametern

tableType - gibt an aus welcher Tabelle die Daten ermittelt werden sollen

Returns:

generisches Objekt von Vorgangsdaten oder null

Since:

4.3.2

getVorgangsData

@Deprecated
public ExtendedEntityModel<Vorgang> getVorgangsData(UserContext uc,
                                                      Projekt pro,
                                                      Vorgang v,
                                                      de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated. use getVorgangsData(UserContext, Projekt, Vorgang, QueryCriteriaManager, EProjectSpecificDBTable)

getVorgaengeDataTotalCount

public long getVorgaengeDataTotalCount(UserContext uc,
                              Projekt projekt,
                              Postfach postfach,
                              de.xima.cmn.criteria.QueryCriteriaManager qcm,
                              EProjectSpecificDBTable tableType)

Methode zum Ermitteln der Gesamtanzahl aller Vorgangsdaten der Vorgänge eines Projekts und Postfachs

Parameters:

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

projekt - das Projekt dem die Vorgänge zugeordnet sind

postfach - das Postfach in dem die Vorgänge liegen

qcm - QueryCriteriaManager mit spezifischen Filterparametern

tableType - gibt an aus welcher Tabelle die Daten ermittelt werden sollen
Bei Auswahl des TabellenTyps EProjectSpecificDBTable.DATA_INBOX kann der Parameter postfach mit null belegt werden

Returns:

Anzahl der Elemente

Since:

4.3.2

getVorgaengeDataTotalCount

public long getVorgaengeDataTotalCount(UserContext uc,
                              Projekt projekt,
                              de.xima.cmn.criteria.QueryCriteriaManager qcm,
                              EProjectSpecificDBTable tableType)

Methode zum Ermitteln der Gesamtanzahl aller Vorgangsdaten der Vorgänge eines Projekts

Parameters:

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

projekt - das Projekt dem die Vorgänge zugeordnet sind

postfach - das Postfach in dem die Vorgänge liegen

qcm - QueryCriteriaManager mit spezifischen Filterparametern

tableType - gibt an aus welcher Tabelle die Daten ermittelt werden sollen

Returns:

Anzahl der Elemente

Since:

4.3.2

getVorgaengeDataTotalCount

@Deprecated
public long getVorgaengeDataTotalCount(UserContext uc,
                                         Projekt projekt,
                                         de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated. use getVorgaengeDataTotalCount(UserContext, Projekt, QueryCriteriaManager, EProjectSpecificDBTable)

getVorgaengeDataTotalCount

@Deprecated
public long getVorgaengeDataTotalCount(UserContext uc,
                                         Projekt projekt,
                                         Postfach postfach,
                                         de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated. use getVorgaengeDataTotalCount(UserContext, Projekt, Postfach, QueryCriteriaManager, EProjectSpecificDBTable)

getCustomAttributes

public Map<String,String> getCustomAttributes(UserContext uc,
                                     Vorgang v)

Methode zum Ermitteln aller CustomAttribute eines Vorgangs

Parameters:

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

vorgang - Vorgang, dessen Custom-Attribute ermittelt werden sollen

Returns:

Map mit Elementen

Since:

4.2.0