com.blockchyp.client.dto

Class Acknowledgement

java.lang.Object

com.blockchyp.client.dto.Acknowledgement

Direct Known Subclasses:

BooleanPromptResponse, CloseBatchResponse, HeartbeatResponse, TerminalRouteResponse, TextPromptResponse

public class Acknowledgement
extends Object

Models basic response information. This is typically used as a base class for most API responses.

Constructor Summary

Constructors

Constructor and Description
Acknowledgement()

Method Summary

Modifier and Type	Method and Description
String	getError() Gets a narrative description of the error, if any.
boolean	isSuccess() Gets the success flag.
void	setError(String error) Sets a narrative description of the error, if any.
void	setSuccess(boolean success) Sets the success flag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Acknowledgement

public Acknowledgement()

Method Detail

isSuccess

public boolean isSuccess()

Gets the success flag.

Returns:

true if the API call succeeded.

setSuccess

public void setSuccess(boolean success)

Sets the success flag.

Parameters:

success - true if the API call succeeded.

getError

public String getError()

Gets a narrative description of the error, if any.

Returns:

narrative description of any error.

setError

public void setError(String error)

Sets a narrative description of the error, if any.

Parameters:

error - narrative description of any error.