Class ResponseInfo
- java.lang.Object
-
- com.gentics.contentnode.rest.model.response.ResponseInfo
-
- All Implemented Interfaces:
Serializable
public class ResponseInfo extends Object implements Serializable
Response information that contains a response code and a response message.
The response message should not be internationalized. If you want to provide a user friendly message use the message object instead.- Author:
- floriangutmann
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ResponseInfo()
Empty construtor.ResponseInfo(ResponseCode responseCode, String responseMessage)
Constructor for a ResponseInfo with all parameters.ResponseInfo(ResponseCode responseCode, String responseMessage, String property)
Create an instance
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getProperty()
Property, that caused the request to fail (may be null)ResponseCode
getResponseCode()
Response codeString
getResponseMessage()
Response messagestatic ResponseInfo
ok(String message)
Create an instance withResponseCode.OK
and messagevoid
setProperty(String property)
void
setResponseCode(ResponseCode responseCode)
void
setResponseMessage(String responseMessage)
-
-
-
Constructor Detail
-
ResponseInfo
public ResponseInfo()
Empty construtor. Necessary for JAXB.
-
ResponseInfo
public ResponseInfo(ResponseCode responseCode, String responseMessage)
Constructor for a ResponseInfo with all parameters.- Parameters:
responseCode
- Code for the responseresponseMessage
- Message for the response
-
ResponseInfo
public ResponseInfo(ResponseCode responseCode, String responseMessage, String property)
Create an instance- Parameters:
responseCode
- response coderesponseMessage
- response messageproperty
- property name
-
-
Method Detail
-
ok
public static ResponseInfo ok(String message)
Create an instance withResponseCode.OK
and message- Parameters:
message
- response message- Returns:
- instance
-
getResponseCode
public ResponseCode getResponseCode()
Response code- Returns:
- response code
-
setResponseCode
public void setResponseCode(ResponseCode responseCode)
-
getResponseMessage
public String getResponseMessage()
Response message- Returns:
- response message
-
setResponseMessage
public void setResponseMessage(String responseMessage)
-
getProperty
public String getProperty()
Property, that caused the request to fail (may be null)- Returns:
- property name
-
setProperty
public void setProperty(String property)
-
-