public class ResultMessage
extends java.lang.Object
ERROR
.
id represents the object upon which the action,which this result represents, was taken.
summary is a short description of the message suitable for display in a UI.
A single action can have multiple fault details. These may be very verbose and may have information to allow a UI to direct a user to try to fix problems.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ERROR |
static java.lang.String |
INFO |
static java.lang.String |
WARN |
Constructor and Description |
---|
ResultMessage() |
ResultMessage(java.lang.String messageType,
java.lang.String summary) |
ResultMessage(java.lang.String messageType,
java.lang.String summary,
java.lang.String detail) |
ResultMessage(java.lang.String messageType,
java.lang.String summary,
java.lang.String detail,
EntityIdentifier id,
AdminException exception) |
ResultMessage(java.lang.String messageType,
java.lang.String summary,
java.lang.String detail,
EntityIdentifier id,
java.lang.Throwable exception) |
Modifier and Type | Method and Description |
---|---|
void |
addFaultDetail(AdminFaultDetail faultDetail) |
void |
appendDependenciesToEntity(EntityDesc desc,
long[] dependencies) |
static ResultMessage |
createErrorMsg(java.lang.String summary,
EntityIdentifier id) |
static ResultMessage |
createErrorMsg(java.lang.String summary,
EntityIdentifier id,
AdminException exception) |
static ResultMessage |
createErrorMsg(java.lang.String summary,
EntityIdentifier id,
java.lang.Throwable exception) |
static ResultMessage |
createErrorMsg(java.lang.Throwable e,
EntityIdentifier id) |
static ResultMessage |
createSuccessMsg(java.lang.String summary,
EntityIdentifier id) |
static ResultMessage |
createWarnMsg(java.lang.String summary,
EntityIdentifier id) |
java.lang.String |
getActionHandle()
Get the action handle for this result.
|
DependenciesPerEntity |
getDependenciesPerEntity(EntityDesc desc) |
DependenciesPerEntity[] |
getDependenciesPerEntityList() |
java.lang.Throwable |
getException() |
AdminFaultDetail[] |
getFaultDetails() |
EntityIdentifier |
getId() |
java.lang.String |
getMessageCode() |
java.lang.String |
getMessageType() |
java.lang.String |
getSummary() |
long[] |
getTaskIds() |
boolean |
isSuccess() |
boolean |
maybeResetMessageType(java.lang.String newMessageType)
Maybe change this ResultMessage's messageType to the newMessageType if it is more critical.
|
void |
mergeResult(ResultMessage result) |
void |
setActionHandle(java.lang.String actionHandle) |
void |
setDependenciesPerEntity(EntityDesc desc,
long[] dependencies) |
void |
setDependenciesPerEntityList(DependenciesPerEntity[] perEntityDependencies) |
void |
setException(java.lang.Throwable exception) |
void |
setFaultDetails(AdminFaultDetail[] faultDetails) |
void |
setId(EntityIdentifier id) |
void |
setMessageCode(java.lang.String messageCode) |
void |
setMessageType(java.lang.String messageType) |
void |
setSummary(java.lang.String summary) |
void |
setTaskIds(long[] taskIds) |
java.lang.String |
toString() |
public static final java.lang.String INFO
public static final java.lang.String WARN
public static final java.lang.String ERROR
public ResultMessage()
public ResultMessage(java.lang.String messageType, java.lang.String summary)
public ResultMessage(java.lang.String messageType, java.lang.String summary, java.lang.String detail)
public ResultMessage(java.lang.String messageType, java.lang.String summary, java.lang.String detail, EntityIdentifier id, AdminException exception)
public ResultMessage(java.lang.String messageType, java.lang.String summary, java.lang.String detail, EntityIdentifier id, java.lang.Throwable exception)
public static ResultMessage createWarnMsg(java.lang.String summary, EntityIdentifier id)
public static ResultMessage createErrorMsg(java.lang.String summary, EntityIdentifier id)
public static ResultMessage createErrorMsg(java.lang.String summary, EntityIdentifier id, AdminException exception)
public static ResultMessage createErrorMsg(java.lang.String summary, EntityIdentifier id, java.lang.Throwable exception)
public static ResultMessage createErrorMsg(java.lang.Throwable e, EntityIdentifier id)
public static ResultMessage createSuccessMsg(java.lang.String summary, EntityIdentifier id)
public boolean isSuccess()
public java.lang.String getMessageType()
public void setMessageType(java.lang.String messageType)
public java.lang.String getMessageCode()
public void setMessageCode(java.lang.String messageCode)
public java.lang.String getActionHandle()
public void setActionHandle(java.lang.String actionHandle)
public java.lang.String getSummary()
public void setSummary(java.lang.String summary)
public EntityIdentifier getId()
public void setId(EntityIdentifier id)
public java.lang.Throwable getException()
public void setException(java.lang.Throwable exception)
public boolean maybeResetMessageType(java.lang.String newMessageType)
newMessageType
- new message type to set to.public AdminFaultDetail[] getFaultDetails()
public void setFaultDetails(AdminFaultDetail[] faultDetails)
public void addFaultDetail(AdminFaultDetail faultDetail)
public java.lang.String toString()
toString
in class java.lang.Object
public void mergeResult(ResultMessage result)
public void setTaskIds(long[] taskIds)
public long[] getTaskIds()
public DependenciesPerEntity[] getDependenciesPerEntityList()
public void setDependenciesPerEntityList(DependenciesPerEntity[] perEntityDependencies)
public DependenciesPerEntity getDependenciesPerEntity(EntityDesc desc)
public void setDependenciesPerEntity(EntityDesc desc, long[] dependencies)
public void appendDependenciesToEntity(EntityDesc desc, long[] dependencies)