com.electrotank.electroserver4.extensions.api
Class PluginApiResponse

java.lang.Object
  com.electrotank.electroserver4.extensions.api.PluginApiResponse

Direct Known Subclasses:

ExtensionBoundUserServerVariableResponse, PluginPrivateMessageResponse, PluginPublicMessageResponse, RoomResponse, RoomVariableResponse, UserServerVariableResponse, UserVariableResponse

public class PluginApiResponse
extends Object

Represents a response from the server in regards to a (generic) plugin request.

Nested Class Summary

static class

PluginApiResponse.Status Enumeration of status states of a PluginApiResponse.

Constructor Summary

PluginApiResponse()
This constructor will be invoked by the server automatically.

Method Summary

PluginApiResponse.Status	getStatus() Gets the status of the response.
boolean	isSuccess() Returns true if the response is successful.
void	setStatus(PluginApiResponse.Status status) Set the status of the response to one of the allowed enumerated states.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginApiResponse

public PluginApiResponse()

This constructor will be invoked by the server automatically.

Method Detail

getStatus

public PluginApiResponse.Status getStatus()

Gets the status of the response.

Returns:

status, one of Success, Failure, PartialSuccess

setStatus

public void setStatus(PluginApiResponse.Status status)

Set the status of the response to one of the allowed enumerated states.

Parameters:

status - Success, Failure, or PartialSuccess

isSuccess

public boolean isSuccess()

Returns true if the response is successful.

Returns:

true if the status is Success