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

Author:

XIMA MEDIA GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
DatenbankZugriffAPI()

Method Summary

Modifier and Type	Method	Description
de.xima.cmn.db.model.SerializableResultSet	executeDBquery(UserContext uc, Mandant mandant, String abfrageName, boolean suppressStatementLimits, Serializable... parameters)	Method for executing a query with parameter.
de.xima.cmn.db.model.SerializableResultSet	executeDBquery(UserContext uc, Mandant mandant, String abfrageName, IReplacerParams placeholderParams, boolean suppressStatementLimits, Serializable... parameters)
de.xima.cmn.db.model.SerializableResultSet	executePublicDBquery(UserContext uc, Mandant client, String queryName, boolean suppressStatementLimits, Serializable[] parameters)
de.xima.cmn.db.model.SerializableResultSet	executePublicDBquery(UserContext uc, Mandant client, String queryName, boolean suppressStatementLimits, Serializable[] parameters, IReplacerParams replacerParams)
Integer	executeSQL(UserContext uc, Integer dbZugriffId, String sql)	Deprecated. use update(UserContext, Integer, String, Serializable...)
de.xima.cmn.db.model.SerializableResultSet	executeSQL(UserContext uc, Integer dbZugriffID, String sql, boolean suppressStatementLimits, Serializable... args)	Method for executing a Query PreparedStatement on the Master-Server.
DatenbankZugriff	getByMandantAndName(UserContext uc, Mandant mandant, String name)	Method for determining of a DatenbankZugriff by the Mandant and DatenbankZugriff name.
DatenbankZugriff	getByUUID(UserContext uc, Mandant client, String uuid)	Returns the DB access with the given UUID
DatenbankZugriff	getByUUID(UserContext uc, Mandant client, UUID uuid)	Returns the DB access with the given UUID
de.xima.cmn.db.model.SerializableResultSet	query(UserContext uc, Mandant mandant, String abfrageName, Serializable... parameters)	Deprecated. use executeDBquery(UserContext, Mandant, String, boolean, Serializable...).
de.xima.cmn.db.model.SerializableResultSet	query(UserContext uc, Integer dbZugriffID, String sql, Serializable... args)	Deprecated. use executeSQL(UserContext, Integer, String, boolean, Serializable...).
int	update(UserContext uc, Integer dbZugriffID, String sql, Serializable... args)	Method for executing a update PreparedStatement on the Master-Server.

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

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, 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

DatenbankZugriffAPI

public DatenbankZugriffAPI()

Method Detail

executeSQL

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

Method for executing a Query PreparedStatement on the Master-Server.

Parameters:

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

dbZugriffID - Integer the DatenbankZugriff ID to which the PreparedStatement to be executed.

sql - String the SQL string of the PreparedStatements.

suppressStatementLimits - Boolean flag to suppress the global result limit of the SQL query.

args - Array of Serializable for setting the parameter of PreparedStatements.

Returns:

Serializable database result object with the query result.

Throws:

PropertyVetoException - if a error occurs.

Since:

2.4.3

query

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

Deprecated.

use executeSQL(UserContext, Integer, String, boolean, Serializable...). Suppression of statement-limits disabled!

Method for executing a Query PreparedStatement on the Master-Server.

Parameters:

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

dbZugriffID - Integer the DatenbankZugriff ID to which the PreparedStatement to be executed.

sql - String the SQL string of the PreparedStatements.

args - Array of Serializable for setting the parameter of PreparedStatements.

Returns:

Serializable database result object with the query result.

Throws:

PropertyVetoException - if a error occurs.

update

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

Method for executing a update PreparedStatement on the Master-Server.

Parameters:

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

dbZugriffID - Integer the DatenbankZugriff ID to which the PreparedStatement to be executed.

sql - String the SQL string of the PreparedStatements.

args - Array of Serializable for setting the parameter of PreparedStatements.

Returns:

Number of the updated rows.

Throws:

PropertyVetoException - if a error occurs.

Since:

2.4.3

getByMandantAndName

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

Method for determining of a DatenbankZugriff by the Mandant and DatenbankZugriff name.

Parameters:

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

mandant - to which the DatenbankZugriff is associated.

name - String the name of DatenbankZugriffs

Returns:

DatenbankZugriff which was searched.

Since:

2.4.3

getByUUID

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

Returns the DB access with the given UUID

Parameters:

uc - UserContext to use

client - Mandant context in which to look for DB access

uuid - String UUID of the DB access

Returns:

DatenbankZugriff for the given UUID and client

Since:

6.x.x

getByUUID

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

Returns the DB access with the given UUID

Parameters:

uc - UserContext to use

client - Mandant context in which to look for DB access

uuid - UUID UUID of the DB access

Returns:

DatenbankZugriff for the given UUID and client

Since:

6.x.x

executeSQL

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

Deprecated.

use update(UserContext, Integer, String, Serializable...)

Method for executing a update PreparedStatement on the Master-Server.

Parameters:

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

dbZugriffId - Integer the DatenbankZugriff ID to which the PreparedStatement to be executed.

sql - String the SQL string of the PreparedStatements.

Returns:

Number of the updated rows.

Throws:

PropertyVetoException - if a error occurs.

executeDBquery

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

Method for executing a query with parameter.

Parameters:

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

mandant - whose query is executed.

abfrageName - name of the data source to be executed.

suppressStatementLimits - Boolean flag to suppress the global result limit of the SQL query.

parameters - to be passed to the data source query.

Returns:

Serializable database result object with the query result.

Throws:

PropertyVetoException - if a error occurs.

IllegalArgumentException - if a error occurs.

Since:

4.3.0

executeDBquery

public de.xima.cmn.db.model.SerializableResultSet executeDBquery(UserContext uc,
                                                                 Mandant mandant,
                                                                 String abfrageName,
                                                                 IReplacerParams placeholderParams,
                                                                 boolean suppressStatementLimits,
                                                                 Serializable... parameters)
                                                          throws PropertyVetoException,
                                                                 IllegalArgumentException

Throws:

PropertyVetoException

IllegalArgumentException

query

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

Deprecated.

use executeDBquery(UserContext, Mandant, String, boolean, Serializable...). Suppression of statement-limits disabled!

Method for executing a query with parameter.

Parameters:

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

mandant - whose query is executed.

abfrageName - name of the data source to be executed.

parameters - to be passed to the data source query.

Returns:

Serializable database result object with the query result.

Throws:

PropertyVetoException - if a error occurs.

IllegalArgumentException - if a error occurs.

executePublicDBquery

public de.xima.cmn.db.model.SerializableResultSet executePublicDBquery(UserContext uc,
                                                                       Mandant client,
                                                                       String queryName,
                                                                       boolean suppressStatementLimits,
                                                                       Serializable[] parameters)
                                                                throws PropertyVetoException,
                                                                       IllegalArgumentException

Throws:

PropertyVetoException

IllegalArgumentException

executePublicDBquery

public de.xima.cmn.db.model.SerializableResultSet executePublicDBquery(UserContext uc,
                                                                       Mandant client,
                                                                       String queryName,
                                                                       boolean suppressStatementLimits,
                                                                       Serializable[] parameters,
                                                                       IReplacerParams replacerParams)
                                                                throws PropertyVetoException,
                                                                       IllegalArgumentException

Throws:

PropertyVetoException

IllegalArgumentException