com.aquenos.cassandra.pvarchiver.server.web.admin.controller.wsapi

Class RunArchiveConfigurationCommandsResponse

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.web.admin.controller.wsapi.RunArchiveConfigurationCommandsResponse

public class RunArchiveConfigurationCommandsResponse
extends Object

Response object for the "run archive configuration commands" function of the web-service API.

This object is primarily intended to facilitate the JSON serialization of the data provided by the API controller. For this reason, it does not perform any checks on the parameters used to construct the object.

Author:

Sebastian Marsching

See Also:

RunArchiveConfigurationCommandsRequest

Constructor Summary

Constructors

Constructor and Description
RunArchiveConfigurationCommandsResponse(String errorMessage, List<ArchiveConfigurationCommandResult> results) Creates a response.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getErrorMessage() Returns the error message indicating a global error (an error that happened before changed where made to the configuration).
List<ArchiveConfigurationCommandResult>	getResults() Returns the results to the commands that were specified with the request.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RunArchiveConfigurationCommandsResponse

public RunArchiveConfigurationCommandsResponse(String errorMessage,
                                               List<ArchiveConfigurationCommandResult> results)

Creates a response. This constructor does not verify the validity of the arguments and simply uses them as-is.

Parameters:

errorMessage - error message indicating a global error (an error that happened before changes where made to the configuration). null if there is no global error (there might still be errors for individual channels).

results - results of the commands that were specified in the request. The results must be in the same order as the commands in the request.

Method Detail

getErrorMessage

public String getErrorMessage()

Returns the error message indicating a global error (an error that happened before changed where made to the configuration). null if there is no global error (there might still be errors for individual channels).

Returns:

global error message.

getResults

public List<ArchiveConfigurationCommandResult> getResults()

Returns the results to the commands that were specified with the request. The results are in the same order as the corresponding commands in the request.

Returns:

results to the commands that were executed.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object