kz.arta.synergy.api.rest.common

Class Wrapper

java.lang.Object

kz.arta.synergy.api.rest.common.Wrapper

public class Wrapper
extends java.lang.Object

Created by IntelliJ IDEA.
User: topa
Date: 30.08.13
Time: 12:05
Содержит методы для формирования json из наиболее часто используемых объектов

Constructor Summary

Constructors

Constructor and Description
Wrapper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getMethodMessage(SMethodMessage message, java.lang.String objectName)
static java.lang.String	wrapError(int code, java.lang.String errorMessage) Метод возвращает json строку с информацией об ошибке
static java.lang.String	wrapError(java.lang.String errorMessage) Метод возвращает json строку с информацией об ошибке
static java.lang.String	wrapError(java.lang.String errorMessage, java.lang.Object... objects)
static java.lang.String	wrapError(java.lang.Throwable exc) формирует стандартный json для возврата информации об ошибке Возвращает json с полями: errorCode - код ошибки ErrorCode.EXCEPTION errorMessage - message из exc
static java.lang.String	wrapErrorInServerResult(<any> serverResult)
static java.lang.String	wrapErrorInt(java.lang.String errorMessage) Метод возвращает json строку с информацией об ошибке errorCode возращается в виде числа, без кавычек
static java.lang.String	wrapServerResult(ServerResult result, java.lang.String objectID, java.lang.String objectName) Формирует стандартный json из объекта ServerResult: Возвращает json с полями: errorCode - результат выполнения errorMessage - сообщение о результате выполнения идентификатор объекта, название идентификатора передается в параметр метода objectName, если objectName = null, идентификатор в json не добавляется
static java.lang.String	wrapSuccessful()
static java.lang.String	wrapSuccessful(java.lang.String message) Метод возвращает json строку с информацией об ошибке
static java.lang.String	wrapSuccessfulWithData(java.lang.Object data) Метод возвращает json строку об успешном выполнении запроса и объект в поле data
static java.lang.String	wrapWarning(java.lang.String errorMessage) Метод возвращает json строку с информацией об ошибке

Methods inherited from class java.lang.Object

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

Constructor Detail

Wrapper

public Wrapper()

Method Detail

wrapServerResult

public static java.lang.String wrapServerResult(ServerResult result,
                                                java.lang.String objectID,
                                                java.lang.String objectName)

Формирует стандартный json из объекта ServerResult

:

Возвращает json с полями:
errorCode - результат выполнения
errorMessage - сообщение о результате выполнения
идентификатор объекта, название идентификатора передается в параметр метода objectName, если objectName = null, идентификатор в json не добавляется

Parameters:

result - экземпляр ServerResult

objectID - идентификатор объекта

objectName - название поля для идентификатора объекта

Returns:

json

wrapError

public static java.lang.String wrapError(java.lang.Throwable exc)

формирует стандартный json для возврата информации об ошибке

Возвращает json с полями:
errorCode - код ошибки ErrorCode.EXCEPTION
errorMessage - message из exc

Parameters:

exc - Exception

Returns:

json

wrapError

public static java.lang.String wrapError(java.lang.String errorMessage)

Метод возвращает json строку с информацией об ошибке

Parameters:

errorMessage - - сообщение об ошибке

Returns:

сообщение об ошибке в json формате

wrapError

public static java.lang.String wrapError(int code,
                                         java.lang.String errorMessage)

Метод возвращает json строку с информацией об ошибке

Parameters:

errorMessage - - сообщение об ошибке

Returns:

сообщение об ошибке в json формате

wrapErrorInt

public static java.lang.String wrapErrorInt(java.lang.String errorMessage)

Метод возвращает json строку с информацией об ошибке errorCode возращается в виде числа, без кавычек

Parameters:

errorMessage - - сообщение об ошибке

Returns:

сообщение об ошибке в json формате

wrapWarning

public static java.lang.String wrapWarning(java.lang.String errorMessage)

Метод возвращает json строку с информацией об ошибке

Parameters:

errorMessage - - сообщение об ошибке

Returns:

wrapError

public static java.lang.String wrapError(java.lang.String errorMessage,
                                         java.lang.Object... objects)

wrapErrorInServerResult

public static java.lang.String wrapErrorInServerResult(<any> serverResult)

wrapSuccessful

public static java.lang.String wrapSuccessful(java.lang.String message)

Метод возвращает json строку с информацией об ошибке

Parameters:

message - - сообщение

Returns:

wrapSuccessful

public static java.lang.String wrapSuccessful()

wrapSuccessfulWithData

public static java.lang.String wrapSuccessfulWithData(java.lang.Object data)

Метод возвращает json строку об успешном выполнении запроса и объект в поле data

Parameters:

data - данные, который надо возвращать

Returns:

пример: { "errorCode": "0", "errorMessage": "Success", "data": { ... } }

getMethodMessage

public static java.lang.String getMethodMessage(SMethodMessage message,
                                                java.lang.String objectName)