acp.beans

Class OperationReply

java.lang.Object

acp.beans.OperationReply

public class OperationReply
extends java.lang.Object

This class represent operation/method invoking result to be sent back to the network clients (eg. Mozilla Firefox Plugin, Microsoft Add-in) when an operation request is made. The result type is set to Object so that any method return type can be stored into it. The status indicate the type of reply: REPLY or ERROR_REPLY.

Author:

Loke Yan Hao

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_REPLY
static int	REPLY The following are a list of available type of reply.

Constructor Summary

Constructors

Constructor and Description
OperationReply() Basic constructor to create an instance of OperationReply object.
OperationReply(int status, java.lang.Object result) Basic constructor to create an instance of OperationReply object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getResult() Return the result to be sent to the client.
int	getStatus() Return the status of the operation reply.
void	setErrorReply(java.lang.String message) Set the operation reply to return an error reply with an error message.
void	setResult(java.lang.Object result) Set the return result to be sent to the client after invoking a method.
void	setStatus(int status) Set the the status of the operation reply.

Methods inherited from class java.lang.Object

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

Field Detail

REPLY

public static final int REPLY

The following are a list of available type of reply. REPLY: Normal reply. ERROR_REPLY: Error when processing the request. The result argument contains the error message.

See Also:

Constant Field Values

ERROR_REPLY

public static final int ERROR_REPLY

See Also:

Constant Field Values

Constructor Detail

OperationReply

public OperationReply()

Basic constructor to create an instance of OperationReply object.

OperationReply

public OperationReply(int status,
              java.lang.Object result)

Basic constructor to create an instance of OperationReply object.

Parameters:

status - the type of reply to send. (REPLY or ERROR_REPLY).

result - the return result after invoking a method.

Method Detail

getStatus

public int getStatus()

Return the status of the operation reply.

The status can be either one of the value: REPLY (0) or ERROR_REPLY (1). When the status is on ERROR_REPLY (1), the result variable of this object will contain the error message to describe the error encounter when invoking a method.

Returns:

the type of the operation reply.

setStatus

public void setStatus(int status)

Set the the status of the operation reply.

Use the constant variable in this class to set it to the appropriate types: REPLY or ERROR_REPLY.

Parameters:

status - the type of the operation reply.

getResult

public java.lang.Object getResult()

Return the result to be sent to the client.

Returns:

the return result after invoking a method.

setResult

public void setResult(java.lang.Object result)

Set the return result to be sent to the client after invoking a method.

Parameters:

result - the return result after invoking a method.

setErrorReply

public void setErrorReply(java.lang.String message)

Set the operation reply to return an error reply with an error message.

Parameters:

message - the error message.