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

Author:

XIMA MEDIA GmbH, XIMA MEDIA GmbH

Field Summary

Fields inherited from class AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor	Description
DatenquelleAPI()

Method Summary

Modifier and Type	Method	Description
de.xima.cmn.db.model.SerializableResultSet	executeDBquery(UserContext uc, Mandant mandant, String datenquellenName, Serializable... parameters)	Deprecated. Use DatenbankZugriffAPI.executeDBquery(UserContext, Mandant, String, boolean, Serializable...) instead.
Datenquelle	getDatenquelleById(UserContext uc, Mandant mandant, int id)	Method for determining a data source of client by the ID.
Datenquelle	getDatenquelleByName(UserContext uc, Mandant mandant, String name)	Method for determining a data source of client by his name.
Datenquelle	getDatenquelleByName(UserContext uc, Mandant mandant, String name, EDatenquellenTyp datenquellenTyp)	Method for determining a data source of a client by the name and type.
List<Datenquelle>	getDatenquellen(UserContext uc, Mandant mandant)	Method for determining all data sources of a Mandant.
Datenquelle	getPublicDatasource(UserContext uc, Mandant mandant, String name, EDatenquellenTyp datenquellenTyp)
Datenquelle	remoteUpdateDataSource(UserContext uc, Datenquelle datenquelle)	Method to update a data source.

Methods inherited from class 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 ASubAPI

getHandlerProvider

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DatenquelleAPI

public DatenquelleAPI()

Method Details

getDatenquellen

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

Method for determining all data sources of a Mandant.

Parameters:

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

mandant - whose Datenquelle is to be determined.

Returns:

List of Datenquelle.

Since:

2.4.3

getDatenquelleByName

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

Method for determining a data source of client by his name.

Parameters:

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

mandant - whose Datenquelle is to be determined.

name - String the name of the data source.

Returns:

Datenquelle the data source.

Since:

2.4.3

getDatenquelleByName

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

Method for determining a data source of a client by the name and type.

Parameters:

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

mandant - whose Datenquelle is to be determined.

name - String the name of the data source.

datenquellenTyp - EDatenquellenTyp after being filtered.

Returns:

Datenquelle the data source.

Since:

5.1.0

getPublicDatasource

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

getDatenquelleById

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

Method for determining a data source of client by the ID.

Parameters:

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

mandant - whose Datenquelle is to be determined.

id - Integer the ID of the data source.

Returns:

Datenquelle the data source.

Since:

2.4.3

remoteUpdateDataSource

public Datenquelle remoteUpdateDataSource(UserContext uc,
 Datenquelle datenquelle)

Method to update a data source.

Parameters:

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

datenquelle - Datenquelle the data source to be updated.

Returns:

Datenquelle the updated data source.

executeDBquery

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

Deprecated.

Use DatenbankZugriffAPI.executeDBquery(UserContext, Mandant, String, boolean, Serializable...) instead.

Method for determining a data source with parameters.

Parameters:

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

mandant - whose Datenquelle is to be determined.

datenquellenName - 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 - will occur when a proposed change to a property represents an unacceptable value.