com.communote.server.web.api.to

Class ApiResult

java.lang.Object

com.communote.server.web.api.to.ApiResult

All Implemented Interfaces:

Serializable

Deprecated.

Use new generated REST-API instead.

@Deprecated
public class ApiResult
extends Object
implements Serializable

The resulting object of an api call is encapsualted into this class. A status defines if the call has been succeeded or not. The message gives an hint on the error case. The actual result object is stored in result.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiResult.ResultStatus Deprecated. The result status.

Constructor Summary

Constructors

Constructor and Description
ApiResult() Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getMessage() Deprecated. Get a message, mainly used in case of errors
Object	getResult() Deprecated.
String	getStatus() Deprecated.
void	setMessage(String message) Deprecated.
void	setResult(Object result) Deprecated.
void	setStatus(String status) Deprecated. Sets the status (must be of a value defined in ApiResult.ResultStatus
String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiResult

public ApiResult()

Deprecated.

Method Detail

getMessage

public String getMessage()

Deprecated.

Get a message, mainly used in case of errors

Returns:

the message

getResult

public Object getResult()

Deprecated.

Returns:

the result object

getStatus

public String getStatus()

Deprecated.

Returns:

the state

setMessage

public void setMessage(String message)

Deprecated.

Parameters:

message - an message

setResult

public void setResult(Object result)

Deprecated.

Parameters:

result - the result object

setStatus

public void setStatus(String status)

Deprecated.

Sets the status (must be of a value defined in ApiResult.ResultStatus

Parameters:

status - status to be set

toString

public String toString()

Deprecated.

Overrides:

toString in class Object