Package 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 class for manipulation of Postfach entities.

Author:

XIMA MEDIA GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
PostfachAPI()

Method Summary

Modifier and Type	Method	Description
void	clear(UserContext uc, Mandant mandant, Postfach postfach)	Deprecated. use clear(UserContext, Postfach)
void	clear(UserContext uc, Postfach postfach)	Method for emptying a Postfach.
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<Postfach>	getAllByClient(UserContext uc, Mandant client)	Returns all inboxes of the given Mandant
List<BenutzerGruppe>	getBenutzergruppen(UserContext uc, Postfach postfach)	Method for determining all usergroups of a Postfach.
Postfach	getByMandantAndName(UserContext uc, Mandant mandant, String name)	Method for determining a Postfach by the Mandant and the Postfach name.
Postfach	getByUUID(UserContext uc, Mandant client, String uuid)	Returns the inbox with the given UUID
Postfach	getByUUID(UserContext uc, Mandant client, UUID uuid)	Returns the inbox with the given UUID
Postfach	getByVorgang(UserContext uc, Vorgang vorgang)	Method for determining a Postfach with the transmitted 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, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getSingleAttributes, getSingleAttributes, resultTotalCount, 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

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

Deprecated.

use clear(UserContext, Postfach)

Method for emptying a Postfach.

Parameters:

uc - UserContext the user context in which the action is to be performed.

mandant - Mandant the client where the data are associated.

postfach - that should be emptied.

clear

public void clear(UserContext uc,
                  Postfach postfach)

Method for emptying a Postfach.

Parameters:

uc - UserContext the user context in which the action is to be performed.

postfach - Postfach that should be emptied.

Since:

4.6.1

getByVorgang

public Postfach getByVorgang(UserContext uc,
                             Vorgang vorgang)

Method for determining a Postfach with the transmitted Vorgang.

Parameters:

uc - UserContext the user context in which the action is to be performed.

vorgang - Vorgang from the Postfach which is searched.

Returns:

Postfach which was searched.

getBenutzergruppen

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

Method for determining all usergroups of a Postfach.

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)

Method for determining a Postfach by the Mandant and the Postfach name.

Parameters:

uc - UserContext the user context in which the action is to be performed.

mandant - whose Postfach is to be determined.

name - String the name of Postfach.

Returns:

Postfach which was searched.

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

getAllByClient

public List<Postfach> getAllByClient(UserContext uc,
                                     Mandant client)

Returns all inboxes of the given Mandant

Parameters:

uc - UserContext the user context in which the action is to be performed

client - Mandant whose inboxes should be looked for

Returns:

List of Postfachs of the given Mandant

Since:

6.0.0

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

getByUUID

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

Returns the inbox with the given UUID

Parameters:

uc - UserContext to use

client - Mandant context in which to look for inbox

uuid - String UUID of the inbox

Returns:

Postfach for the given UUID and client

Since:

6.x.x

getByUUID

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

Returns the inbox with the given UUID

Parameters:

uc - UserContext to use

client - Mandant context in which to look for inbox

uuid - UUID UUID of the inbox

Returns:

Postfach for the given UUID and client

Since:

6.x.x