de.xima.fc.api.entity

Class PostfachAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.PostfachAPI

public class PostfachAPI
extends AEntityAPI<Postfach>

API-Klassse zur Manipulation von Postfach-Entitäten

Author:

Michael Kohlsche

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor and Description
PostfachAPI()

Method Summary

Modifier and Type	Method and Description
void	clear(UserContext uc, Mandant mandant, Postfach postfach) Deprecated. use clear(UserContext, Postfach)
void	clear(UserContext uc, Postfach postfach) Methode zum Leeren eines Postfachs
List<Postfach>	getAllByBenutzer(UserContext uc, Benutzer benutzer) Methode zum Ermitteln aller Postfächer, die einem Nutzer zugewiesen sind.
List<Postfach>	getAllByBenutzergruppe(UserContext uc, BenutzerGruppe benutzerGruppe) Methode zum Ermitteln aller Postfächer, die einer BenutzerGruppe zugeordnet sind.
List<BenutzerGruppe>	getBenutzergruppen(UserContext uc, Postfach postfach) Methode zum Ermitteln alle Benutzergruppen eines Postfachs.
Postfach	getByMandantAndName(UserContext uc, Mandant mandant, String name) Methode zum Ermitteln eines Postfachs anhand des Mandant und des Postfach-Namen.
Postfach	getByVorgang(UserContext uc, Vorgang vorgang)
List<ExtendedPostfach>	getExtendedPostfaecherByBenutzer(UserContext uc, Benutzer benutzer) Methode zum Ermitteln aller Postfächer, die einem Nutzer zugewiesen sind.

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

PostfachAPI

public PostfachAPI()

Method Detail

clear

public void clear(UserContext uc,
                  Mandant mandant,
                  Postfach postfach)

Deprecated. use clear(UserContext, Postfach)

clear

public void clear(UserContext uc,
                  Postfach postfach)

Methode zum Leeren eines Postfachs

Parameters:

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

postfach - das geleert werden soll @since 4.6.1

getByVorgang

public Postfach getByVorgang(UserContext uc,
                             Vorgang vorgang)

getBenutzergruppen

public List<BenutzerGruppe> getBenutzergruppen(UserContext uc,
                                               Postfach postfach)

Methode zum Ermitteln alle Benutzergruppen eines Postfachs.

Parameters:

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

postfach - Postfach dessen Gruppen gesucht sind

Returns:

Liste von BenutzerGruppen @since 2.4.3

getByMandantAndName

public Postfach getByMandantAndName(UserContext uc,
                                    Mandant mandant,
                                    String name)

Methode zum Ermitteln eines Postfachs anhand des Mandant und des Postfach-Namen.

Parameters:

mandant - dessen Postfach ermittelt werden soll

name - String der Name des Postfachs

Returns:

Postfach der gesucht wurde @since 2.4.3

getAllByBenutzer

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

Methode zum Ermitteln aller Postfächer, die einem Nutzer zugewiesen sind.

Parameters:

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

benutzer - Benutzer dessen Postfacher gesucht werden

Returns:

Liste von Postfachern @since 2.4.3

getAllByBenutzergruppe

public List<Postfach> getAllByBenutzergruppe(UserContext uc,
                                             BenutzerGruppe benutzerGruppe)

Methode zum Ermitteln aller Postfächer, die einer BenutzerGruppe zugeordnet sind.

Parameters:

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

benutzerGruppe - deren Postfächer ermittelt werden sollen

Returns:

List mit Postfach @since 2.4.3

getExtendedPostfaecherByBenutzer

public List<ExtendedPostfach> getExtendedPostfaecherByBenutzer(UserContext uc,
                                                               Benutzer benutzer)

Methode zum Ermitteln aller Postfächer, die einem Nutzer zugewiesen sind. Zusätzlich enthält die ExtendedPostfach noch Informationen, welche Projekte ein konfiguriertes Postfach besitzen.

Parameters:

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

benutzer - Benutzer dessen Postfacher gesucht werden

Returns:

Liste von ExtendedPostfach @since 2.4.3