com.sap.cloud.sdk.service.prov.api

Interface ChangeSetHandler

public interface ChangeSetHandler

Provides the control to retrieve the request, process it, and add the corresponding response for each operation in the changeset.

Method Summary

Modifier and Type	Method and Description
boolean	addResponse(Response response) Appends the response to the changeset and returns true if successful.
Response	handleRequest(Request request) Executes the annotated method corresponding to the data modification operations.
boolean	hasNextRequest() Returns true, if the changeset has additional operations, otherwise, it returns false.
Request	nextRequest() Returns request information corresponding to the next operation in the changeset.

Method Detail

hasNextRequest

boolean hasNextRequest()

Returns true, if the changeset has additional operations, otherwise, it returns false. Please note this method returns false, if an exception occurs while processing the changeset.

Returns:

A boolean indicating the presence of next request

nextRequest

Request nextRequest()
             throws Exception

Returns request information corresponding to the next operation in the changeset. Please note this method returns null, if an exception occurs while processing the changeset.

Returns:

A Request object corresponding to the next operation

Throws:

Exception - if either the replacement of the content ID or the request deserialization fails

Exception

handleRequest

Response handleRequest(Request request)
                throws Exception

Executes the annotated method corresponding to the data modification operations. This annotated method is invoked based on the HTTP method, service name, and entity name specified in the request.

Parameters:

request - A Request object corresponding to an operation

Returns:

A Response object corresponding to the processed operation

Throws:

Exception - if the annotated method corresponding to the operation is not defined

Exception

addResponse

boolean addResponse(Response response)
             throws Exception

Appends the response to the changeset and returns true if successful. Please note this method returns false, if an exception occurs while processing the changeset.

Parameters:

response - A Response object corresponding to an operation

Returns:

boolean indicating success or failure

Throws:

Exception - if the response object contains an exception, response serialization fails, or the content ID mapping fails

Exception