com.sap.cloud.sdk.service.prov.api.annotations.Function 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

The newest version!

/*******************************************************************************
 * (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 Function annotation attached to a public method specifies
* that the method provides the implementation logic of a function.
*
* 
*  A method to which this annotation is attached supports two signatures depending on the following scenarios:
* 
*  
* SCENARIO 1: You're executing the function on your local HANA database.
* 	

* 		
* 			Input parameter of type {@link com.sap.cloud.sdk.service.prov.api.request.OperationRequest OperationRequest}
* 		
*   	
* 			Input parameter of type {@link com.sap.cloud.sdk.service.prov.api.ExtensionHelper ExtensionHelper} 
* 		
* 		
* 			Return value of type {@link com.sap.cloud.sdk.service.prov.api.response.OperationResponse OperationResponse}
* 		
* 	
*  
*  
*  
* SCENARIO 2: You're executing the function only on a remote data source.
* 	

* 		
* 			Input parameter of type {@link com.sap.cloud.sdk.service.prov.api.request.OperationRequest OperationRequest}
* 		
* 		
* 			Return value of type {@link com.sap.cloud.sdk.service.prov.api.response.OperationResponse OperationResponse}
* 		
* 	
*  
*  
* 
* @param serviceName Name of the service
* @param Name Name of the function within the service
*/

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Function {
	String serviceName() default "";
	String Name();
}