org.geomajas.command

Class CommandResponse

java.lang.Object

org.geomajas.command.CommandResponse

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SuccessCommandResponse

@Api(allMethods=true)
public class CommandResponse
extends Object
implements Serializable

Base result object from executing a command. This can contain actual data or hold error-messages.

Since:

1.6.0

Author:

Jan De Moerloose, Joachim Van der Auwera

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandResponse()

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getErrorMessages() Get the list of error messages which occurred when dispatching the command.
List<Throwable>	getErrors() Get the list of exceptions which are thrown while dispatching the command.
List<ExceptionDto>	getExceptions() Returns a list of serializable exceptions.
long	getExecutionTime() Get execution time in milliseconds.
String	getId() Get the id assigned to this command.
boolean	isError() Determine whether an error occurred while dispatching the command.
void	setExecutionTime(long executionTime) Set the execution time in milliseconds for the command.
void	setId(String id) Set the id assigned to this command.
String	toString() String to display as command dispatcher trace.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandResponse

public CommandResponse()

Method Detail

isError

public boolean isError()

Determine whether an error occurred while dispatching the command.

Returns:

true when an exception occurred during command processing

getId

public String getId()

Get the id assigned to this command. The id can help you to match client and server side logs about a command.

Returns:

id

setId

public void setId(String id)

Set the id assigned to this command. The id can help you to match client and server side logs about a command.

Parameters:

id - id

getErrorMessages

public List<String> getErrorMessages()

Get the list of error messages which occurred when dispatching the command. These messages are localised.

Returns:

list of error messages

getErrors

public List<Throwable> getErrors()

Get the list of exceptions which are thrown while dispatching the command. This list is used (by the dispatcher) to fill the errorMessages list.
Serializable since 1.8.0.

Returns:

list of Throwables

getExecutionTime

public long getExecutionTime()

Get execution time in milliseconds.

Returns:

command execution time in milliseconds

setExecutionTime

public void setExecutionTime(long executionTime)

Set the execution time in milliseconds for the command.

Parameters:

executionTime - command execution time in milliseconds

getExceptions

public List<ExceptionDto> getExceptions()

Returns a list of serializable exceptions. These exceptions are actually send to the client.

Returns:

The exception list.

Since:

1.8.0

toString

public String toString()

String to display as command dispatcher trace.

Overrides:

toString in class Object

Returns:

string representation of respone

Since:

1.10.0