org.nuxeo.box.api.marshalling.dao

Class BoxServerError

java.lang.Object

org.nuxeo.box.api.marshalling.dao.BoxBase

org.nuxeo.box.api.marshalling.jsonentities.DefaultJSONStringEntity

org.nuxeo.box.api.marshalling.dao.BoxObject

org.nuxeo.box.api.marshalling.dao.BoxTypedObject

org.nuxeo.box.api.marshalling.dao.BoxServerError

All Implemented Interfaces:

IBoxJSONStringEntity

Direct Known Subclasses:

BoxGenericServerError

public class BoxServerError
extends BoxTypedObject

Class for errors sent from server.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_CODE
static String	FIELD_HELP_URL
static String	FIELD_MESSAGE
static String	FIELD_REQUEST_ID
static String	FIELD_STATUS

Fields inherited from class org.nuxeo.box.api.marshalling.dao.BoxTypedObject

FIELD_CREATED_AT, FIELD_ID, FIELD_MODIFIED_AT, FIELD_TYPE

Constructor Summary

Constructors

Constructor and Description
BoxServerError()
BoxServerError(BoxServerError obj) Copy constructor, this does deep copy for all the fields.
BoxServerError(Map<String,Object> map) Instantiate the object from a map.

Method Summary

Modifier and Type	Method and Description
String	getCode()
String	getHelpUrl()
Integer	getHttpStatusCode() Deprecated.
String	getMessage()
String	getRequestId()
Integer	getStatus()
protected void	setCode(String code) Setter.
protected void	setHelpUrl(String helpUrl) Setter.
protected void	setMessage(String message) Setter.
protected void	setRequestId(String requestId) Setter.
void	setStatus(Integer status) Setter.

Methods inherited from class org.nuxeo.box.api.marshalling.dao.BoxTypedObject

dateCreatedAt, dateModifiedAt, getCreatedAt, getId, getModifiedAt, getType, resourceType, setType

Methods inherited from class org.nuxeo.box.api.marshalling.dao.BoxObject

contains, equals, getExtraData, getKeySet, getValue, handleUnknown, hashCode, properties, put, putAll

Methods inherited from class org.nuxeo.box.api.marshalling.jsonentities.DefaultJSONStringEntity

toJSONString

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_STATUS

public static final String FIELD_STATUS

See Also:

Constant Field Values

FIELD_CODE

public static final String FIELD_CODE

See Also:

Constant Field Values

FIELD_HELP_URL

public static final String FIELD_HELP_URL

See Also:

Constant Field Values

FIELD_MESSAGE

public static final String FIELD_MESSAGE

See Also:

Constant Field Values

FIELD_REQUEST_ID

public static final String FIELD_REQUEST_ID

See Also:

Constant Field Values

Constructor Detail

BoxServerError

public BoxServerError()

BoxServerError

public BoxServerError(BoxServerError obj)

Copy constructor, this does deep copy for all the fields.

Parameters:

obj -

BoxServerError

public BoxServerError(Map<String,Object> map)

Instantiate the object from a map. Each entry in the map reflects to a field.

Parameters:

map -

Method Detail

getStatus

public Integer getStatus()

Returns:

the status

setStatus

public void setStatus(Integer status)

Setter. This is only used by Jackson JSON processer

Parameters:

status - the status to set

getCode

public String getCode()

Returns:

the code

setCode

protected void setCode(String code)

Setter. This is only used by Jackson JSON processer

Parameters:

code - the code to set

getHelpUrl

public String getHelpUrl()

Returns:

the help_url

setHelpUrl

protected void setHelpUrl(String helpUrl)

Setter. This is only used by Jackson JSON processer

Parameters:

helpUrl - the help_url to set

getMessage

public String getMessage()

Returns:

the message

setMessage

protected void setMessage(String message)

Setter. This is only used by Jackson JSON processer

Parameters:

message - the message to set

getRequestId

public String getRequestId()

Returns:

the request_id

setRequestId

protected void setRequestId(String requestId)

Setter. This is only used by Jackson JSON processer

Parameters:

requestId - the request_id to set

getHttpStatusCode

@Deprecated
public Integer getHttpStatusCode()

Deprecated.

Deprecated, use getStatus() instead

Returns:

status code