Package de.dlr.proseo.planner

Class PlannerResultMessage

java.lang.Object

de.dlr.proseo.planner.PlannerResultMessage

public class PlannerResultMessage
extends Object

Wrapper class for ProseoMessages

Author:

Ernst Melchinger

Constructor Summary

Constructors

Constructor	Description
PlannerResultMessage(ProseoMessage msg)	Create a new instance of PlannerResultMessage with a given prosEO message.

Method Summary

Modifier and Type	Method	Description
PlannerResultMessage	copy(PlannerResultMessage msg)	Copy the contents of another PlannerResultMessage to this instance.
int	getCode()	Get the message code.
org.slf4j.event.Level	getLevel()	Get the message level.
ProseoMessage	getMessage()	Get the prosEO message.
boolean	getSuccess()	Check if the message is considered successful.
String	getText()	Get the complete message text.
void	setMessage(ProseoMessage message)	Set the prosEO message.
void	setText(String text)	Set the complete message text.

Methods inherited from class java.lang.Object

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

Constructor Details

PlannerResultMessage

public PlannerResultMessage(ProseoMessage msg)

Create a new instance of PlannerResultMessage with a given prosEO message.

Parameters:

msg - The prosEO message.

Method Details

getMessage

public ProseoMessage getMessage()

Get the prosEO message.

Returns:

The prosEO message.

getText

public String getText()

Get the complete message text.

Returns:

The complete message text.

setMessage

public void setMessage(ProseoMessage message)

Set the prosEO message.

Parameters:

message - The prosEO message to set.

setText

public void setText(String text)

Set the complete message text.

Parameters:

text - The complete message text to set.

copy

public PlannerResultMessage copy(PlannerResultMessage msg)

Copy the contents of another PlannerResultMessage to this instance.

Parameters:

msg - The PlannerResultMessage to copy.

Returns:

This PlannerResultMessage instance.

getSuccess

public boolean getSuccess()

Check if the message is considered successful. A message is considered successful unless its level is error.

Returns:

True if the message is successful, false otherwise.

getCode

public int getCode()

Get the message code.

Returns:

The message code.

getLevel

public org.slf4j.event.Level getLevel()

Get the message level.

Returns:

The message level.