de.xima.fc.api.entity

Class DatenquelleAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.DatenquelleAPI

public class DatenquelleAPI
extends AEntityAPI<Datenquelle>

API-Klassse zur Manipulation von Datenquelle-Entitäten

Author:

sha, mko

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor and Description
DatenquelleAPI()

Method Summary

Modifier and Type	Method and Description
de.xima.cmn.db.model.SerializableResultSet	executeDBquery(UserContext uc, Mandant mandant, String datenquellenName, Serializable... parameters) Deprecated.
Datenquelle	getDatenquelleById(UserContext uc, Mandant mandant, int id) Methode zum Ermitteln einer Datenquelle eines Mandanten anhand der id
Datenquelle	getDatenquelleByName(UserContext uc, Mandant mandant, String name) Deprecated. use getDatenquelleByName(UserContext, Mandant, String, EDatenquellenTyp) instead
Datenquelle	getDatenquelleByName(UserContext uc, Mandant mandant, String name, EDatenquellenTyp datenquellenTyp) Methode zum Ermitteln einer Datenquelle eines Mandanten anhand des Names und Typs
List<Datenquelle>	getDatenquellen(UserContext uc, Mandant mandant) Methode zum ermitteln aller Datenquellen eines Mandanten

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

DatenquelleAPI

public DatenquelleAPI()

Method Detail

getDatenquellen

public List<Datenquelle> getDatenquellen(UserContext uc,
                                         Mandant mandant)

Methode zum ermitteln aller Datenquellen eines Mandanten

Parameters:

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

mandant - dessen Datenquellen ermittel werden sollen

Returns:

Liste von Datenquellen

Since:

2.4.3

getDatenquelleByName

@Deprecated
public Datenquelle getDatenquelleByName(UserContext uc,
                                                    Mandant mandant,
                                                    String name)

Deprecated. use getDatenquelleByName(UserContext, Mandant, String, EDatenquellenTyp) instead

Methode zum Ermitteln einer Datenquelle eines Mandanten anhand des Names

Parameters:

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

mandant - dessen Datenquelle ermittel werden sollen

name - String der Name der Datenquelle

Returns:

Datenquelle die Datenquell

Since:

2.4.3

getDatenquelleByName

public Datenquelle getDatenquelleByName(UserContext uc,
                                        Mandant mandant,
                                        String name,
                                        EDatenquellenTyp datenquellenTyp)

Methode zum Ermitteln einer Datenquelle eines Mandanten anhand des Names und Typs

Parameters:

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

mandant - dessen Datenquelle ermittel werden sollen

name - String der Name der Datenquelle

datenquellenTyp - EDatenquellenTyp nach dem gefiltert wird

Returns:

Datenquelle die Datenquell

Since:

5.1.0

getDatenquelleById

public Datenquelle getDatenquelleById(UserContext uc,
                                      Mandant mandant,
                                      int id)

Methode zum Ermitteln einer Datenquelle eines Mandanten anhand der id

Parameters:

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

mandant - dessen Datenquelle ermittel werden sollen

id - Integer die ID der Datenquelle

Returns:

Datenquelle die Datenquell

Since:

2.4.3

executeDBquery

@Deprecated
public de.xima.cmn.db.model.SerializableResultSet executeDBquery(UserContext uc,
                                                                             Mandant mandant,
                                                                             String datenquellenName,
                                                                             Serializable... parameters)
                                                                      throws PropertyVetoException

Deprecated.

Methode zum Ausführen einer Datenquelle mit Parametern

Parameters:

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

mandant - dessen Datenquelle ausgeführt wird

datenquellenName - name der Datenquelle die ausgeführt werdne soll

parameters - Parameter die der Datenquellenabfrage übergeben werden sollen

Returns:

Serialisierbares Datenbank-Result-Objekt mit den Abfrageergebnissen

Throws:

PropertyVetoException