com.sap.cloud.sdk.service.prov.api.annotations.ExtendDelete 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 ExtendDelete annotation attached to a public method specifies that the method implements
* the Delete operation of an entity set in a service. This method overrides the default Delete operation of
* the generic OData service provisioned by the SDK.
*
*  A method to which this annotation is attached must provide the following:
* 	

* 		
* 			Input parameter of type {@link com.sap.cloud.sdk.service.prov.api.request.DeleteRequest DeleteRequest}
* 		
* 		
* 			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.DeleteResponse DeleteResponse}
* 		
* 	
*  
*
* @param entity Name of the entity
* @param serviceName [optional] Name of the service to which the entity belongs
* 
* @deprecated As of version 1.16.0, replaced by {@link Delete} 
*/
@Deprecated
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ExtendDelete {
	String serviceName() default "";
	String entity() default "";
	
	//Using entitySet name in the annotation does not makes sense as user only specify entity name in CDS. use entity instead.
	@Deprecated
	String[] entitySet() default {};
}