org.openestate.is24.restapi.utils

Class ExportMessage

java.lang.Object

org.openestate.is24.restapi.utils.ExportMessage

All Implemented Interfaces:

Serializable

public class ExportMessage
extends Object
implements Serializable

A message, that was returned during a bulk export.

The ExportMessage is part of the high level API for bulk exports of real estate data.

Since:

0.2

Author:

Andreas Rudolph

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExportMessage.Code Supported message codes.
static class	ExportMessage.Level Supported message levels.

Method Summary

Modifier and Type	Method and Description
ExportMessage.Code	getCode() Return message code.
String	getContactId() Return the contact ID, that this message is assigned to.
String	getErrorRequestRefNumber() Return the unique identifier of the failed HTTP request.
ExportMessage.Level	getLevel() Return message level.
String	getMessage() Return message text.
String	getObjectId() Return the real estate ID, that this message is assigned to.
boolean	isError() Check, if the message is an error.
boolean	isGeneral() Check, if the message is assigned to a certain object.
boolean	isNotice() Check, if the message is a notice.
boolean	isWarning() Check, if the message is a warning.
static ExportMessage	newContactMessage(String contactId, ExportMessage.Code code, String message) Create a message for a contact person.
static ExportMessage	newContactMessage(String contactId, ExportMessage.Code code, String message, String errorRequestRefNumber) Create a message for a contact person.
static ExportMessage	newGeneralMessage(String message, ExportMessage.Code code) Create a general message.
static ExportMessage	newGeneralMessage(String message, ExportMessage.Code code, String errorRequestRefNumber) Create a general message.
static ExportMessage	newObjectMessage(String objectId, ExportMessage.Code code, String message) Create a message for a real estate.
static ExportMessage	newObjectMessage(String objectId, ExportMessage.Code code, String message, String errorRequestRefNumber) Create a message for a real estate.

Methods inherited from class java.lang.Object

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

Method Detail

getCode

public ExportMessage.Code getCode()

Return message code.

Returns:

message code

getContactId

public String getContactId()

Return the contact ID, that this message is assigned to.

Returns:

contact ID or null, if no contact is assigned to the message

getErrorRequestRefNumber

public String getErrorRequestRefNumber()

Return the unique identifier of the failed HTTP request.

This values was passed through the L-IS24-RequestRefnum header of the HTTP response.

Returns:

unique identifier

Since:

0.2.2

getLevel

public ExportMessage.Level getLevel()

Return message level.

Returns:

message level

getMessage

public String getMessage()

Return message text.

Returns:

message text

getObjectId

public String getObjectId()

Return the real estate ID, that this message is assigned to.

Returns:

real estate ID or null, if no real estate is assigned to the message

isError

public boolean isError()

Check, if the message is an error.

Returns:

true, if the message is an error

isGeneral

public boolean isGeneral()

Check, if the message is assigned to a certain object.

Returns:

true, if the message is assigned to a contact or real estate

isNotice

public boolean isNotice()

Check, if the message is a notice.

Returns:

true, if the message is a notice

isWarning

public boolean isWarning()

Check, if the message is a warning.

Returns:

true, if the message is a warning

newContactMessage

public static ExportMessage newContactMessage(String contactId,
                                              ExportMessage.Code code,
                                              String message)

Create a message for a contact person.

Parameters:

contactId - contact ID

code - message code

message - message text

Returns:

message

newContactMessage

public static ExportMessage newContactMessage(String contactId,
                                              ExportMessage.Code code,
                                              String message,
                                              String errorRequestRefNumber)

Create a message for a contact person.

Parameters:

contactId - contact ID

code - message code

message - message text

errorRequestRefNumber - unique identifier of the failed HTTP request

Returns:

message

Since:

0.2.2

newGeneralMessage

public static ExportMessage newGeneralMessage(String message,
                                              ExportMessage.Code code)

Create a general message.

Parameters:

code - message code

message - message text

Returns:

message

newGeneralMessage

public static ExportMessage newGeneralMessage(String message,
                                              ExportMessage.Code code,
                                              String errorRequestRefNumber)

Create a general message.

Parameters:

code - message code

message - message text

errorRequestRefNumber - unique identifier of the failed HTTP request

Returns:

message

Since:

0.2.2

newObjectMessage

public static ExportMessage newObjectMessage(String objectId,
                                             ExportMessage.Code code,
                                             String message)

Create a message for a real estate.

Parameters:

objectId - real estate ID

code - message code

message - message text

Returns:

message

newObjectMessage

public static ExportMessage newObjectMessage(String objectId,
                                             ExportMessage.Code code,
                                             String message,
                                             String errorRequestRefNumber)

Create a message for a real estate.

Parameters:

objectId - real estate ID

code - message code

message - message text

errorRequestRefNumber - unique identifier of the failed HTTP request

Returns:

message

Since:

0.2.2