com.sap.cloud.sdk.service.prov.api.annotations.InitTransaction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

SAP Cloud Platform SDK for service development

There is a newer version: 1.40.11

/*******************************************************************************
 * (c) 201X SAP SE or an SAP affiliate company. All rights reserved.
 ******************************************************************************/
package com.sap.cloud.sdk.service.prov.api.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* The InitTransaction annotation attached to a public method specifies that the method is
* invoked just after the transaction starts and before any operation executes.
* 
*
*  A method to which this annotation is attached must provide the following parameters:
* 	

* 		
* 			Input parameter of type List<{@link com.sap.cloud.sdk.service.prov.api.request.Request Request}>
* 		
* 		
* 			Input parameter of type {@link com.sap.cloud.sdk.service.prov.api.ExtensionHelper ExtensionHelper}
* 		
* 	
*  
*  A method to which this annotation is attached must provide one of the following return types:
* 	

* 		
* 			void 
* 		
* 		
* 			Object of type {@link com.sap.cloud.sdk.service.prov.api.exits.InitTransactionResponse InitTransactionResponse}
* 		
* 	
*    
*
* @param serviceName [optional] Name of the service. The annotated method applies to all entity sets within the specified
*                               service. If service name is not provided then this method executes for any entity set in
*                               any service.
*/
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface InitTransaction {
	String[] serviceNames() default {};
}