com.communote.plugins.api.rest.v24.to

Class ApiResult<T>

java.lang.Object

com.communote.plugins.api.rest.v24.to.ApiResult<T>

Type Parameters:

T - the capsuled resource

All Implemented Interfaces:

Serializable

public class ApiResult<T>
extends Object
implements Serializable

The resulting object of an api call is encapsulated 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.DevelopmentView View class for development purposes.
static class	ApiResult.PublicView View class for development purposes.
static class	ApiResult.ResultStatus The result status.

Constructor Summary

Constructors

Constructor and Description
ApiResult()

Method Summary

Modifier and Type	Method and Description
List<ApiResultError>	getErrors()
String	getMessage() Get a message, mainly used in case of errors
Map<String,Object>	getMetaData() Get a map of meta data
T	getResult()
String	getStatus()
void	setErrors(List<ApiResultError> errors)
void	setMessage(String message)
void	setMetaData(Map<String,Object> metaData) Set the meta data for the response
void	setResult(T result)
void	setStatus(String status) Sets the status (must be of a value defined in ApiResult.ResultStatus
String	toString()
void	writeToOutputStream(OutputStream outputStream) Writes the object in json format to the given stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiResult

public ApiResult()

Method Detail

getErrors

public List<ApiResultError> getErrors()

Returns:

the errors

getMessage

public String getMessage()

Get a message, mainly used in case of errors

Returns:

the message

getMetaData

public Map<String,Object> getMetaData()

Get a map of meta data

Returns:

map of meta data

getResult

public T getResult()

Returns:

the result object

getStatus

public String getStatus()

Returns:

the state

setErrors

public void setErrors(List<ApiResultError> errors)

Parameters:

errors - the errors to set

setMessage

public void setMessage(String message)

Parameters:

message - an message

setMetaData

public void setMetaData(Map<String,Object> metaData)

Set the meta data for the response

Parameters:

metaData - map with meta data to extend the result

setResult

public void setResult(T result)

Parameters:

result - the result object

setStatus

public void setStatus(String status)

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

Parameters:

status - status to be set

toString

public String toString()

Overrides:

toString in class Object

writeToOutputStream

public void writeToOutputStream(OutputStream outputStream)
                         throws IOException

Writes the object in json format to the given stream.

Parameters:

outputStream - The stream to write the object to.

Throws:

IOException - Exception.