Package net.webpdf.wsclient.openapi

Class WebserviceResult

java.lang.Object

net.webpdf.wsclient.openapi.WebserviceResult

public class WebserviceResult
extends Object

Defines the result of the execution of a web service operation. The result contains in `code` the value zero if the execution was successful or a negative number as error code if an error occurred. In case of an error code, `description` contains a description of the error and `stackTrace` contains the Java stack trace if an exception occurred.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_CODE
static String	JSON_PROPERTY_DESCRIPTION
static String	JSON_PROPERTY_EXIT_CODE
static String	JSON_PROPERTY_STACK_TRACE

Constructor Summary

Constructors

Constructor	Description
WebserviceResult()

Method Summary

Modifier and Type	Method	Description
WebserviceResult	code(Integer code)
WebserviceResult	description(String description)
boolean	equals(Object o)
WebserviceResult	exitCode(Integer exitCode)
@Nullable Integer	getCode()	The error code of the operation.
@Nullable String	getDescription()	A description of the operation´s result.
@Nullable Integer	getExitCode()	The exit code of an external application, if such an application was used for the operation.
@Nullable WebserviceResultStackTrace	getStackTrace()	Get stackTrace
int	hashCode()
void	setCode(Integer code)
void	setDescription(String description)
void	setExitCode(Integer exitCode)
void	setStackTrace(WebserviceResultStackTrace stackTrace)
WebserviceResult	stackTrace(WebserviceResultStackTrace stackTrace)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_CODE

public static final String JSON_PROPERTY_CODE

See Also:

Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

Constant Field Values

JSON_PROPERTY_EXIT_CODE

public static final String JSON_PROPERTY_EXIT_CODE

See Also:

Constant Field Values

JSON_PROPERTY_STACK_TRACE

public static final String JSON_PROPERTY_STACK_TRACE

See Also:

Constant Field Values

Constructor Detail

WebserviceResult

public WebserviceResult()

Method Detail

code

public WebserviceResult code(Integer code)

getCode

@Nullable
public @Nullable Integer getCode()

The error code of the operation. For a successful operation, this value must be zero. If you get any other negative value, the execution has failed.

Returns:

code

setCode

public void setCode(Integer code)

description

public WebserviceResult description(String description)

getDescription

@Nullable
public @Nullable String getDescription()

A description of the operation´s result.

Returns:

description

setDescription

public void setDescription(String description)

exitCode

public WebserviceResult exitCode(Integer exitCode)

getExitCode

@Nullable
public @Nullable Integer getExitCode()

The exit code of an external application, if such an application was used for the operation.

Returns:

exitCode

setExitCode

public void setExitCode(Integer exitCode)

stackTrace

public WebserviceResult stackTrace(WebserviceResultStackTrace stackTrace)

getStackTrace

@Nullable
public @Nullable WebserviceResultStackTrace getStackTrace()

Get stackTrace

Returns:

stackTrace

setStackTrace

public void setStackTrace(WebserviceResultStackTrace stackTrace)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object