com.sap.cloud.sdk.service.prov.api.response.DeleteResponse 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.response;

import com.sap.cloud.sdk.service.prov.api.response.impl.DeleteResponseBuilderImpl;
import com.sap.cloud.sdk.service.prov.api.response.impl.DeleteResponseImpl;

/**
 * Provides the methods for creating a response in the case of a successful or failed delete operation.
 */
public abstract class DeleteResponse extends Response {
	/**
	 * Returns a response builder using which the response header and the content can be populated
	 * in the event of a successful delete operation. 
	 * @return A DeleteResponseBuilder object	
	 */
	public static DeleteResponseBuilder setSuccess(){
		return new DeleteResponseBuilderImpl();
	}
	
	/**
	 * Populates error in the response in the event of a failed delete operation,
	 * and returns the same.
	 * @param errorResponse An ErrorResponse object containing the error message and status code
	 * @return A DeleteResponse object	containing the error
	 */
	public static DeleteResponse setError(ErrorResponse errorResponse){
		return new DeleteResponseImpl(errorResponse);
	}
}