com.sap.cloud.sdk.s4hana.connectivity.rfc

Class JCoTransaction<QueryT extends AbstractRemoteFunctionQuery<QueryT,QueryResultT>,QueryResultT extends AbstractRemoteFunctionQueryResult<QueryT,QueryResultT>>

java.lang.Object

com.sap.cloud.sdk.s4hana.connectivity.rfc.JCoTransaction<QueryT,QueryResultT>

Type Parameters:

QueryT - The type of the query to execute.

QueryResultT - The type of the result to return.

All Implemented Interfaces:

Transaction<QueryT,QueryResultT>

public class JCoTransaction<QueryT extends AbstractRemoteFunctionQuery<QueryT,QueryResultT>,QueryResultT extends AbstractRemoteFunctionQueryResult<QueryT,QueryResultT>>
extends Object
implements Transaction<QueryT,QueryResultT>

Implementation of the Transaction interface to be used for JCo queries.

Constructor Summary

Constructors

Constructor and Description
JCoTransaction(String destinationName, Supplier<QueryResultT> queryResultFactory) Constructs a JCoTransaction for the given destinationName and queryResultFactory.

Method Summary

Modifier and Type	Method and Description
void	after() This method gets called *in any case* after the transactional calls are done.
void	before(ErpConfigContext configContext, QueryT query) This method gets called before anything else gets called in the RemoteFunctionQueryExecutor.
void	commit(ErpConfigContext configContext, QueryT query) If Transaction.execute(ErpConfigContext, AbstractRemoteFunctionQuery) succeeded, this method is called to actually commit the changes.
QueryResultT	execute(ErpConfigContext configContext, QueryT query) The actual logic to be executed.
protected List<com.sap.cloud.sdk.s4hana.connectivity.rfc.AbstractRemoteFunctionQueryResult.Result>	getReturnParameterResults(QueryResultT result)
void	rollback(ErpConfigContext configContext, QueryT query) If there was a problem with Transaction.execute(ErpConfigContext, AbstractRemoteFunctionQuery) or Transaction.commit(ErpConfigContext, AbstractRemoteFunctionQuery) this method will get called to rollback any unwanted changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

JCoTransaction

public JCoTransaction(@Nonnull
                      String destinationName,
                      @Nonnull
                      Supplier<QueryResultT> queryResultFactory)
               throws RemoteFunctionException

Constructs a JCoTransaction for the given destinationName and queryResultFactory.

Parameters:

destinationName - Name of the destination to be used. Otherwise, it would not be clear which destination name to use from the ErpConfigContext

queryResultFactory - Provider to be used to create a QueryResultT object.

Throws:

RemoteFunctionException - If there was an error while getting the actual destionation for the given destinationName.

Method Detail

before

public void before(@Nonnull
                   ErpConfigContext configContext,
                   @Nonnull
                   QueryT query)

Description copied from interface: Transaction

This method gets called before anything else gets called in the RemoteFunctionQueryExecutor.

Specified by:

before in interface Transaction<QueryT extends AbstractRemoteFunctionQuery<QueryT,QueryResultT>,QueryResultT extends AbstractRemoteFunctionQueryResult<QueryT,QueryResultT>>

Parameters:

configContext - The ErpConfigContext of this call.

query - The AbstractRemoteFunctionQuery going to be executed.

execute

@Nonnull
public QueryResultT execute(@Nonnull
                                     ErpConfigContext configContext,
                                     @Nonnull
                                     QueryT query)
                              throws RemoteFunctionException

Description copied from interface: Transaction

The actual logic to be executed.

Specified by:

execute in interface Transaction<QueryT extends AbstractRemoteFunctionQuery<QueryT,QueryResultT>,QueryResultT extends AbstractRemoteFunctionQueryResult<QueryT,QueryResultT>>

Parameters:

configContext - The ErpConfigContext of this call.

query - The AbstractRemoteFunctionQuery going to execute.

Returns:

The AbstractRemoteFunctionQueryResult created by the query.

Throws:

RemoteFunctionException

getReturnParameterResults

protected List<com.sap.cloud.sdk.s4hana.connectivity.rfc.AbstractRemoteFunctionQueryResult.Result> getReturnParameterResults(QueryResultT result)

commit

public void commit(@Nonnull
                   ErpConfigContext configContext,
                   @Nonnull
                   QueryT query)
            throws QueryExecutionException

Description copied from interface: Transaction

If Transaction.execute(ErpConfigContext, AbstractRemoteFunctionQuery) succeeded, this method is called to actually commit the changes.

Specified by:

commit in interface Transaction<QueryT extends AbstractRemoteFunctionQuery<QueryT,QueryResultT>,QueryResultT extends AbstractRemoteFunctionQueryResult<QueryT,QueryResultT>>

Parameters:

configContext - The ErpConfigContext of this call.

query - The AbstractRemoteFunctionQuery that was executed.

Throws:

QueryExecutionException - If an exception occurred during the commit implementation.

rollback

public void rollback(@Nonnull
                     ErpConfigContext configContext,
                     @Nonnull
                     QueryT query)
              throws QuerySerializationException,
                     QueryExecutionException

Description copied from interface: Transaction

If there was a problem with Transaction.execute(ErpConfigContext, AbstractRemoteFunctionQuery) or Transaction.commit(ErpConfigContext, AbstractRemoteFunctionQuery) this method will get called to rollback any unwanted changes.

Specified by:

rollback in interface Transaction<QueryT extends AbstractRemoteFunctionQuery<QueryT,QueryResultT>,QueryResultT extends AbstractRemoteFunctionQueryResult<QueryT,QueryResultT>>

Parameters:

configContext - The ErpConfigContext of this call.

query - The AbstractRemoteFunctionQuery that was executed.

Throws:

QueryExecutionException - If an exception occurred during the rollback implementation.

QuerySerializationException

after

public void after()
           throws RemoteFunctionException

Description copied from interface: Transaction

This method gets called *in any case* after the transactional calls are done.

Specified by:

after in interface Transaction<QueryT extends AbstractRemoteFunctionQuery<QueryT,QueryResultT>,QueryResultT extends AbstractRemoteFunctionQueryResult<QueryT,QueryResultT>>

Throws:

RemoteFunctionException - If an exception occurred during the after implementation.