public static class Retire_Suggestions.Messages
extends java.lang.Object
Special attention should be paid to messages that are associated with the parent suggestion. Even if the parent suggestion was successfully retired, warning messages may have been generated to indicate such things as overlapping stereo targets or other instances where an overlapping suggestion might get retired but was not retired due to some special case that might warrant some attention on the part of the planner.
In addition, overriding the default retirement operation can be accomplished by resetting the willRetire(boolean) method to the appropriate value and passing the Map back to the retireSuggestions(String,Map) method.
Constructor and Description |
---|
Messages()
Instantiate the class with empty warning messages, and all boolean flags
set to false.
|
Modifier and Type | Method and Description |
---|---|
void |
addWarning(java.lang.String message)
This method is called by the
Retire_Suggestions class to store
warning messages generated during the retirement process. |
void |
appendInformation(java.lang.String message)
This method is called by the
Retire_Suggestions class to store
messages generated during the retirement process |
java.lang.String |
getScienceRationale()
Get the science rationale for the associated suggestion
|
java.lang.String |
getSpecialNotes()
Get the special notes for the suggestion
|
java.lang.String |
getSTLDescription()
Get the STL Description for the associated suggestion
|
int |
getSuggestionId()
Get the Suggestion ID this Messages class was created for.
|
boolean |
isParent()
Indicates if the suggestion this Messages object was generated for is the
parent of the retiring observation.
|
boolean |
isRetired() |
void |
isRetired(boolean status)
This method is called by the
Retire_Suggestions class during the
retiring process to indicate if the retiring process was successful. |
void |
setParent(boolean status)
Set the parent status on the messages class.
|
void |
setScienceRationale(java.lang.String description)
Set the science rationale for the associated suggestion
|
void |
setSpecialNotes(java.lang.String notes)
Set the special notes for the target
|
void |
setSTLDescription(java.lang.String description)
Sets the STL Description
|
void |
setSuggestionId(int suggestionId)
Set the Suggestion Id this Messages instance has been generated for.
|
java.util.ArrayList<java.lang.String> |
statusMessages()
Get the list of status messages that may have been generated
during the retirement process.
|
java.util.ArrayList<java.lang.String> |
warningMessages()
Gets any warning messages that were generated during the retirement
process.
|
boolean |
Warnings()
A boolean value that gets set if any warning messages were generated
during the retirement process.
|
boolean |
willRetire()
Get the success status that was generated during the retirement process.
|
void |
willRetire(boolean status) |
public Messages()
public java.util.ArrayList<java.lang.String> warningMessages()
Warnings()
public java.util.ArrayList<java.lang.String> statusMessages()
public void appendInformation(java.lang.String message)
Retire_Suggestions
class to store
messages generated during the retirement processmessage
- A string containing a status message.public void addWarning(java.lang.String message)
Retire_Suggestions
class to store
warning messages generated during the retirement process.message
- A string containing a warning message.public boolean Warnings()
warningMessages()
method should be called to get the warnings messages
that were generated.warningMessages()
public void setSuggestionId(int suggestionId)
suggestionId
- - an integer ID, this should the Suggestion ID stored in
the Suggested_Observations table in HiCat.public int getSuggestionId()
public void setParent(boolean status)
status
- a boolean value indicating if the suggestion is the parent of the
retiring observation.public boolean isParent()
public void isRetired(boolean status)
Retire_Suggestions
class during the
retiring process to indicate if the retiring process was successful.status
- true if the retiring process succeded, false otherwise.public boolean isRetired()
public void willRetire(boolean status)
public boolean willRetire()
public void setSTLDescription(java.lang.String description)
description
- public java.lang.String getSTLDescription()
public void setScienceRationale(java.lang.String description)
description
- public java.lang.String getScienceRationale()
public void setSpecialNotes(java.lang.String notes)
notes
- public java.lang.String getSpecialNotes()
Copyright \ (C) Arizona Board of Regents on behalf of the \ Planetary Image Research Laboratory, Lunar and \ Planetary Laboratory at the University of Arizona