kalix.javasdk.testkit.ValueEntityResult Maven / Gradle / Ivy
/*
* Copyright 2024 Lightbend Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package kalix.javasdk.testkit;
import io.grpc.Status;
import java.util.List;
/**
* Represents the result of an ValueEntity handling a command when run in through the testkit.
*
* Not for user extension, returned by the testkit.
*
* @param The type of reply that is expected from invoking a command handler
*/
public interface ValueEntityResult {
/** @return true if the call had an effect with a reply, false if not */
boolean isReply();
/**
* @return The reply object from the handler if there was one. If the call had an effect without
* any reply an exception is thrown.
*/
R getReply();
/** @return true if the call was forwarded, false if not */
boolean isForward();
/**
* @return An object with details about the forward. If the result was not a forward an exception
* is thrown.
*/
DeferredCallDetails getForward();
/** @return true if the call was an error, false if not */
boolean isError();
/** The error description. If the result was not an error an exception is thrown */
String getError();
/**
* @return The error status code or throws if the effect returned by the action was not an error.
*/
Status.Code getErrorStatusCode();
/** @return true if the call updated the entity state */
boolean stateWasUpdated();
/** @return The updated state. If the state was not updated an exeption is thrown */
Object getUpdatedState();
/** @return true if the call deleted the entity */
boolean stateWasDeleted();
/** @return The list of side effects */
List> getSideEffects();
}