Package org.openwms.common.comm.osip.err

Class ErrorMessage

java.lang.Object

org.openwms.common.comm.osip.Payload

org.openwms.common.comm.osip.err.ErrorMessage

All Implemented Interfaces:

Serializable

public class ErrorMessage
extends Payload
implements Serializable

An ErrorMessage signals any error or failure situation from or to an external system.

Author:

Heiko Scherrer

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ErrorMessage.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDENTIFIER	Message identifier "ERR_" .
private String	locationGroupName

Fields inherited from class org.openwms.common.comm.osip.Payload

DATE_LENGTH, ERROR_CODE_LENGTH, MESSAGE_IDENTIFIER_LENGTH

Constructor Summary

Constructors

Modifier	Constructor	Description
	ErrorMessage()
private	ErrorMessage(ErrorMessage.Builder builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Use all fields.
String	getLocationGroupName()
String	getMessageIdentifier()	Subclasses have to return an unique, case-sensitive message identifier.
int	hashCode()	Use all fields.
boolean	isWithoutReply()	Does this type of message needs to be replied to?
static ErrorMessage.Builder	newBuilder()
void	setLocationGroupName(String locationGroupName)
String	toString()	Use all fields.

Methods inherited from class org.openwms.common.comm.osip.Payload

exists, getCreated, getErrorCode, getHeader, hasErrorCode, setCreated, setErrorCode, setHeader

Methods inherited from class java.lang.Object

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

Field Details

IDENTIFIER

public static final String IDENTIFIER

Message identifier "ERR_" .

See Also:

• Constant Field Values

locationGroupName

private String locationGroupName

Constructor Details

ErrorMessage

public ErrorMessage()

ErrorMessage

private ErrorMessage(ErrorMessage.Builder builder)

Method Details

newBuilder

public static ErrorMessage.Builder newBuilder()

getLocationGroupName

public String getLocationGroupName()

setLocationGroupName

public void setLocationGroupName(String locationGroupName)

getMessageIdentifier

public String getMessageIdentifier()

Subclasses have to return an unique, case-sensitive message identifier.

Specified by:

getMessageIdentifier in class Payload

Returns:

The message TYPE field (see OSIP specification)

isWithoutReply

public boolean isWithoutReply()

Does this type of message needs to be replied to?

Specified by:

isWithoutReply in class Payload

Returns:

true no reply needed, otherwise false

equals

public boolean equals(Object o)

Use all fields. Use all fields.

Overrides:

equals in class Payload

hashCode

public int hashCode()

Use all fields. Use all fields.

Overrides:

hashCode in class Payload

toString

public String toString()

Use all fields. Use all fields.

Overrides:

toString in class Payload