Package de.xima.fc.handler.interfaces.entity

Interface IDatenquelleHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

DatenquelleHandler

public interface IDatenquelleHandler
extends IGenericHandler

API handler for data source entities.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
Datenquelle	getDatenquelleById(UserContext uc, Mandant client, int id)	Gets a data source by its database ID.
Datenquelle	getDatenquelleByName(UserContext uc, Mandant client, String name)	Gets a data source with a given name.
Datenquelle	getDatenquelleByNameAndType(UserContext uc, Mandant client, String name, EDatenquellenTyp dataSourceType)	Gets a data source of a certain type that has the given name.
List<Datenquelle>	getDatenquellen(UserContext uc, Mandant client)	Gets all data sources owned by the given client.
Datenquelle	getPublicDatasource(UserContext uc, Mandant client, String name, EDatenquellenTyp dataSourceType)	Gets a public data source
Datenquelle	remoteUpdateDataSource(UserContext uc, Datenquelle dataSource)	Updates a data source.

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Method Detail

getDatenquelleById

Datenquelle getDatenquelleById(UserContext uc,
                               Mandant client,
                               int id)

Gets a data source by its database ID.

Parameters:

uc - The user context of the user who requested the data source.

client - The client who owns the data source.

id - The database ID of the data source.

Returns:

The data source with the given ID, or null if not found.

getDatenquelleByName

Datenquelle getDatenquelleByName(UserContext uc,
                                 Mandant client,
                                 String name)

Gets a data source with a given name.

Parameters:

uc - The user context of the user who requested the data source.

client - The client who owns the data source.

name - The name of the data source.

Returns:

The data source with the given name, or null if not found.

getDatenquelleByNameAndType

Datenquelle getDatenquelleByNameAndType(UserContext uc,
                                        Mandant client,
                                        String name,
                                        EDatenquellenTyp dataSourceType)

Gets a data source of a certain type that has the given name.

Parameters:

uc - The user context of the user who requested the data source.

client - The client who owns the data source.

name - The name of the data source.

dataSourceType - The type of the data source.

Returns:

The data source with the given name and type, or null if not found.

Since:

5.1.0

getDatenquellen

List<Datenquelle> getDatenquellen(UserContext uc,
                                  Mandant client)

Gets all data sources owned by the given client.

Parameters:

uc - The user context of the user who requested the data sources.

client - The client who owns the data sources.

Returns:

All data sources owned by the client, or an empty list if none are found.

getPublicDatasource

Datenquelle getPublicDatasource(UserContext uc,
                                Mandant client,
                                String name,
                                EDatenquellenTyp dataSourceType)

Gets a public data source

Parameters:

uc - The user context of the user who requested the data source.

client - The client who owns the data source.

name - The name of the data source.

dataSourceType - The type of the data source.

Returns:

The retrieved data source or null if not found or the data source is not public.

remoteUpdateDataSource

Datenquelle remoteUpdateDataSource(UserContext uc,
                                   Datenquelle dataSource)

Updates a data source.

Parameters:

uc - The user context of the user who requested the update.

dataSource - The data source to update.

Returns:

The updated data source or null if the update failed.