de.xima.fc.api.entity

Class DatenbankZugriffAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.DatenbankZugriffAPI

public class DatenbankZugriffAPI
extends AEntityAPI<DatenbankZugriff>

API-Klassse zur Manipulation von DatenbankZugriff-Entitäten

Author:

Michael Kohlsche

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor and Description
DatenbankZugriffAPI()

Method Summary

Modifier and Type	Method and Description
Integer	executeSQL(UserContext uc, Integer dbZugriffId, String sql) Methode zum Ausführen eines SQL-Statments auf dem Master-Server.
DatenbankZugriff	getByMandantAndName(UserContext uc, Mandant mandant, String name) Methode zum Ermitteln eines DatenbankZugriffs anhand des Mandant und des DatenbankZugriff -Namen.
de.xima.cmn.db.model.SerializableResultSet	query(UserContext uc, Integer dbZugriffID, String sql, Serializable... args) Methode zum Ausführen eines Query-PreparedStatement auf dem Master-Server
de.xima.cmn.db.model.SerializableResultSet	query(UserContext uc, Mandant mandant, String abfrageName, Serializable... parameters) Methode zum Ausführen einer Abfrage mit Parametern
int	update(UserContext uc, Integer dbZugriffID, String sql, Serializable... args) Methode zum Ausführen eines Update-PreparedStatement auf dem Master-Server

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

DatenbankZugriffAPI

public DatenbankZugriffAPI()

Method Detail

query

public de.xima.cmn.db.model.SerializableResultSet query(UserContext uc,
                                                        Integer dbZugriffID,
                                                        String sql,
                                                        Serializable... args)
                                                 throws PropertyVetoException

Methode zum Ausführen eines Query-PreparedStatement auf dem Master-Server

Parameters:

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

dbZugriffID - Integer die ID des DatenbankZugriff zu welchem das PreparedStatement ausgeführt werden soll

sql - String der SQL-String des PreparedStatements

args - Array aus Object zum Setzen der Parameter des PreparedStatements

Returns:

Serialisierbares Datenbank-Result-Objekt mit den Abfrageergebnissen @ bei Fehlern

Throws:

PropertyVetoException

Since:

2.4.3

update

public int update(UserContext uc,
                  Integer dbZugriffID,
                  String sql,
                  Serializable... args)
           throws PropertyVetoException

Methode zum Ausführen eines Update-PreparedStatement auf dem Master-Server

Parameters:

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

dbZugriffID - Integer die ID des DatenbankZugriff zu welchem das PreparedStatement ausgeführt werden soll

sql - String der SQL-String des PreparedStatements

args - Array aus Object zum Setzen der Parameter des PreparedStatements

Returns:

Anzahl der aktualisierten Zeilen @ bei Fehlern

Throws:

PropertyVetoException

Since:

2.4.3

getByMandantAndName

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

Methode zum Ermitteln eines DatenbankZugriffs anhand des Mandant und des DatenbankZugriff -Namen.

Parameters:

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

mandant - welchem der DatenbankZugriff zugeordnet ist

name - String der Name des DatenbankZugriffs

Returns:

DatenbankZugriff der gesucht wurde @ bei Fehlern

Since:

2.4.3

executeSQL

public Integer executeSQL(UserContext uc,
                          Integer dbZugriffId,
                          String sql)
                   throws PropertyVetoException

Methode zum Ausführen eines SQL-Statments auf dem Master-Server. Dieses kann anders als DatenbankZugriffAPI , z.B. auch ein Update, Drop und co., sein

Parameters:

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

dbZugriffId - Integer die ID des DatenbankZugriff zu welchem das PreparedStatement

sql - String der SQL-String des PreparedStatements

Returns:

Anzahl der Statements die Ausgeführt wurden. @ Fehler beim Ausführen des SQLs

Throws:

PropertyVetoException

Since:

2.4.3

query

public de.xima.cmn.db.model.SerializableResultSet query(UserContext uc,
                                                        Mandant mandant,
                                                        String abfrageName,
                                                        Serializable... parameters)
                                                 throws PropertyVetoException,
                                                        IllegalArgumentException

Methode zum Ausführen einer Abfrage mit Parametern

Parameters:

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

mandant - dessen Abfrage ausgeführt wird

abfrageName - 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

IllegalArgumentException

Since:

4.3.0