com.sap.cloud.sdk.service.prov.api

Interface DataSourceHandler

public interface DataSourceHandler

Method Summary

Modifier and Type	Method and Description
boolean	executeDelete(String entityName, Map<String,Object> keys) Deletes an entity instance.
EntityData	executeInsert(EntityData entityData, boolean returnCreatedEntity) Creates an entity instance.
<T> T	executeInsert(T pojoData, String entityName, boolean returnCreatedEntity) Creates an entity instance.
EntityData	executeInsertWithAssociations(EntityData entityData, boolean returnCreatedEntity) Creates an entity instance with associated entities.
EntityData	executeRead(String entityName, Map<String,Object> keys, List<String> flattenedElementNames) Reads an entity instance.
EntityData	executeUpdate(EntityData entityData, Map<String,Object> keys, boolean returnUpdatedEntity) Updates an entity instance.

Method Detail

executeInsert

EntityData executeInsert(EntityData entityData,
                         boolean returnCreatedEntity)
                  throws DatasourceException

Creates an entity instance.

Parameters:

entityData - Represents the entity to be created

returnCreatedEntity - Indicates whether the created entity needs to be returned

Returns:

Based on the value of returnCreatedEntity, either the created entity or null is returned.

Throws:

DatasourceException - If an issue with the data source occurs

executeInsert

<T> T executeInsert(T pojoData,
                    String entityName,
                    boolean returnCreatedEntity)
             throws DatasourceException

Creates an entity instance.

Parameters:

pojoData - Represents the entity to be created

entityName - Name of the entity

returnCreatedEntity - Indicates whether the created entity needs to be returned

Returns:

Based on the value of returnCreatedEntity, either the created entity or null is returned.

Throws:

DatasourceException - If an issue with the data source occurs

executeInsertWithAssociations

EntityData executeInsertWithAssociations(EntityData entityData,
                                         boolean returnCreatedEntity)
                                  throws DatasourceException

Creates an entity instance with associated entities.

Parameters:

entityData - Represents the entity and its associated entities to be created

returnCreatedEntity - Indicates whether the created entity needs to be returned

Returns:

Based on the value of returnCreatedEntity, either the created entity or null is returned.

Throws:

DatasourceException - If an issue with the data source occurs

executeUpdate

EntityData executeUpdate(EntityData entityData,
                         Map<String,Object> keys,
                         boolean returnUpdatedEntity)
                  throws DatasourceException

Updates an entity instance.

Parameters:

entityData - Represents the entity to be updated

returnUpdatedEntity - Indicates whether the updated entity needs to be returned

Returns:

Based on the value of returnUpdatedEntity, either the updated entity or null is returned.

Throws:

DatasourceException - If an issue with the data source occurs

executeDelete

boolean executeDelete(String entityName,
                      Map<String,Object> keys)
               throws DatasourceException

Deletes an entity instance.

Parameters:

entityName - Name of the entity to be deleted

keys - Key-value pair identifying a particular entity instance

Returns:

true if the entity is deleted, false otherwise

Throws:

DatasourceException - If an issue with the data source occurs

executeRead

EntityData executeRead(String entityName,
                       Map<String,Object> keys,
                       List<String> flattenedElementNames)
                throws DatasourceException

Reads an entity instance.

Parameters:

entityName - Name of the entity to be read

keys - Key-value pair identifying a particular entity instance

flattenedElementNames - Names of elements that have to be read. For elements in a structured type, the flattened name has to be given.

Returns:

entity read from the data source

Throws:

DatasourceException - If an issue with the data source occurs