Interface IDatenquelleHandler
-
- All Superinterfaces:
IAPIHandler
,IGenericHandler
,Serializable
- All Known Implementing Classes:
DatenquelleHandler
public interface IDatenquelleHandler extends IGenericHandler
API handler fordata source
entities.- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Datenquelle
getDatenquelleById(UserContext uc, Mandant client, int id)
Gets adata source
by its databaseID
.Datenquelle
getDatenquelleByName(UserContext uc, Mandant client, String name)
Gets adata source
with a givenname
.Datenquelle
getDatenquelleByNameAndType(UserContext uc, Mandant client, String name, EDatenquellenTyp dataSourceType)
List<Datenquelle>
getDatenquellen(UserContext uc, Mandant client)
Gets alldata sources
owned by the givenclient
.Datenquelle
getPublicDatasource(UserContext uc, Mandant client, String name, EDatenquellenTyp dataSourceType)
Gets apublic
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 adata source
by its databaseID
.- 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 adata source
with a givenname
.- 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)
- 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 alldata sources
owned by the givenclient
.- 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 apublic
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.
-
-