|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.evolveum.midpoint.schema.result.OperationResult
public class OperationResult
Nested Operation Result. This class provides information for better error handling in complex operations. It contains a status (success, failure, warning, ...) and an error message. It also contains a set of sub-results - results on inner operations. This object can be used by GUI to display smart (and interactive) error information. It can also be used by the client code to detect deeper problems in the invocations, retry or otherwise compensate for the errors or decide how severe the error was and it is possible to proceed.
Field Summary | |
---|---|
static String |
CONTEXT_IMPLEMENTATION_CLASS
|
static String |
CONTEXT_ITEM
|
static String |
CONTEXT_OBJECT
|
static String |
CONTEXT_OID
|
static String |
CONTEXT_PROGRESS
|
static String |
CONTEXT_TASK
|
static String |
PARAM_OBJECT
|
static String |
PARAM_OID
|
static String |
PARAM_OPTIONS
|
static String |
PARAM_TASK
|
static String |
PARAM_TYPE
|
static String |
RETURN_COUNT
|
Constructor Summary | |
---|---|
OperationResult(String operation)
|
|
OperationResult(String operation,
long token,
String messageCode,
String message)
|
|
OperationResult(String operation,
Map<String,Object> params,
OperationResultStatus status,
long token,
String messageCode,
String message)
|
|
OperationResult(String operation,
Map<String,Object> params,
OperationResultStatus status,
long token,
String messageCode,
String message,
List<OperationResult> subresults)
|
|
OperationResult(String operation,
Map<String,Object> params,
OperationResultStatus status,
long token,
String messageCode,
String message,
String localizationMessage,
List<Object> localizationArguments,
Throwable cause,
List<OperationResult> subresults)
|
|
OperationResult(String operation,
Map<String,Object> params,
OperationResultStatus status,
long token,
String messageCode,
String message,
String localizationMessage,
Throwable cause,
List<OperationResult> subresults)
|
|
OperationResult(String operation,
OperationResultStatus status,
long token,
String messageCode,
String message)
|
|
OperationResult(String operation,
OperationResultStatus status,
long token,
String messageCode,
String message,
Throwable cause)
|
|
OperationResult(String operation,
OperationResultStatus status,
String message)
|
|
OperationResult(String operation,
OperationResultStatus status,
String messageCode,
String message)
|
|
OperationResult(String operation,
String messageCode,
String message)
|
Method Summary | ||
---|---|---|
void |
addContext(String contextName,
Object value)
|
|
void |
addParam(String paramName,
Object paramValue)
|
|
void |
addParams(String[] names,
Object... objects)
|
|
void |
addReturn(String returnName,
Object value)
|
|
void |
addSubresult(OperationResult subresult)
|
|
void |
appendDetail(String detailLine)
|
|
void |
computeStatus()
Computes operation result status based on subtask status. |
|
void |
computeStatus(String errorMessage)
Computes operation result status based on subtask status and sets an error message if the status is FATAL_ERROR. |
|
void |
computeStatus(String errorMessage,
String warnMessage)
|
|
static OperationResult |
createOperationResult(OperationResultType result)
|
|
OperationResultType |
createOperationResultType()
|
|
OperationResult |
createSubresult(String operation)
|
|
String |
debugDump()
Show the content of the object intended for diagnostics by system administrator. |
|
String |
debugDump(int indent)
|
|
String |
dump()
Show the content of the object intended for diagnostics by developer. |
|
String |
dump(boolean withStack)
|
|
OperationResult |
findSubresult(String operation)
|
|
Throwable |
getCause()
|
|
OperationResultStatus |
getComputeStatus()
|
|
Map<String,Object> |
getContext()
|
|
|
getContext(Class<T> type,
String contextName)
|
|
int |
getCount()
|
|
List<String> |
getDetail()
|
|
OperationResult |
getLastSubresult()
|
|
OperationResultStatus |
getLastSubresultStatus()
|
|
List<Object> |
getLocalizationArguments()
|
|
String |
getLocalizationMessage()
|
|
String |
getMessage()
|
|
String |
getMessageCode()
Contains mesage code based on module error catalog. |
|
String |
getOperation()
Contains operation name. |
|
Map<String,Object> |
getParams()
Method returns Map with operation parameters. |
|
Object |
getReturn(String returnName)
|
|
Map<String,Object> |
getReturns()
|
|
OperationResultStatus |
getStatus()
Contains operation status as defined in OperationResultStatus |
|
List<OperationResult> |
getSubresults()
Method returns list of operation subresults @{link OperationResult . |
|
long |
getToken()
|
|
boolean |
hasUnknownStatus()
Returns true if result status is UNKNOWN or any of the subresult status is unknown (recursive). |
|
void |
incrementCount()
|
|
boolean |
isAcceptable()
Returns true if the result is acceptable for further processing. |
|
boolean |
isError()
|
|
boolean |
isHandledError()
|
|
boolean |
isInProgress()
|
|
boolean |
isNotApplicable()
|
|
boolean |
isPartialError()
|
|
boolean |
isSuccess()
Returns true if the result is success. |
|
boolean |
isSummarizeErrors()
|
|
boolean |
isSummarizePartialErrors()
|
|
boolean |
isSummarizeSuccesses()
|
|
boolean |
isUnknown()
|
|
boolean |
isWarning()
|
|
void |
muteError()
If the operation is an error then it will switch the status to EXPECTED_ERROR. |
|
void |
muteLastSubresultError()
|
|
void |
recomputeStatus()
|
|
void |
recomputeStatus(String message)
|
|
void |
recomputeStatus(String errorMessage,
String warningMessage)
|
|
void |
record(CommonException exception)
Records result from a common exception type. |
|
void |
recordFatalError(String message)
|
|
void |
recordFatalError(String message,
Throwable cause)
|
|
void |
recordFatalError(Throwable cause)
|
|
void |
recordHandledError(String message)
|
|
void |
recordInProgress()
|
|
void |
recordPartialError(String message)
|
|
void |
recordPartialError(String message,
Throwable cause)
|
|
void |
recordPartialError(Throwable cause)
|
|
void |
recordStatus(OperationResultStatus status,
String message)
|
|
void |
recordStatus(OperationResultStatus status,
String message,
Throwable cause)
|
|
void |
recordStatus(OperationResultStatus status,
Throwable cause)
|
|
void |
recordSuccess()
|
|
void |
recordSuccessIfUnknown()
|
|
void |
recordUnknown()
|
|
void |
recordWarning(String message)
|
|
void |
recordWarning(String message,
Throwable cause)
|
|
void |
recordWarning(Throwable cause)
|
|
void |
removeLastSubresult()
|
|
void |
setCount(int count)
|
|
void |
setErrorsHandled()
Set all error status in this result and all subresults as handled. |
|
void |
setStatus(OperationResultStatus status)
|
|
void |
setSummarizeErrors(boolean summarizeErrors)
|
|
void |
setSummarizePartialErrors(boolean summarizePartialErrors)
|
|
void |
setSummarizeSuccesses(boolean summarizeSuccesses)
|
|
void |
summarize()
|
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String CONTEXT_IMPLEMENTATION_CLASS
public static final String CONTEXT_PROGRESS
public static final String CONTEXT_OID
public static final String CONTEXT_OBJECT
public static final String CONTEXT_ITEM
public static final String CONTEXT_TASK
public static final String PARAM_OID
public static final String PARAM_TYPE
public static final String PARAM_OPTIONS
public static final String PARAM_TASK
public static final String PARAM_OBJECT
public static final String RETURN_COUNT
Constructor Detail |
---|
public OperationResult(String operation)
public OperationResult(String operation, String messageCode, String message)
public OperationResult(String operation, long token, String messageCode, String message)
public OperationResult(String operation, OperationResultStatus status, String message)
public OperationResult(String operation, OperationResultStatus status, String messageCode, String message)
public OperationResult(String operation, OperationResultStatus status, long token, String messageCode, String message)
public OperationResult(String operation, OperationResultStatus status, long token, String messageCode, String message, Throwable cause)
public OperationResult(String operation, Map<String,Object> params, OperationResultStatus status, long token, String messageCode, String message)
public OperationResult(String operation, Map<String,Object> params, OperationResultStatus status, long token, String messageCode, String message, List<OperationResult> subresults)
public OperationResult(String operation, Map<String,Object> params, OperationResultStatus status, long token, String messageCode, String message, String localizationMessage, Throwable cause, List<OperationResult> subresults)
public OperationResult(String operation, Map<String,Object> params, OperationResultStatus status, long token, String messageCode, String message, String localizationMessage, List<Object> localizationArguments, Throwable cause, List<OperationResult> subresults)
Method Detail |
---|
public OperationResult createSubresult(String operation)
public String getOperation()
String
constant in module interface with description and possible parameters. It
can be used for further processing. It will be used as key for
translation in admin-gui.
public int getCount()
public void setCount(int count)
public void incrementCount()
public boolean isSummarizeErrors()
public void setSummarizeErrors(boolean summarizeErrors)
public boolean isSummarizePartialErrors()
public void setSummarizePartialErrors(boolean summarizePartialErrors)
public boolean isSummarizeSuccesses()
public void setSummarizeSuccesses(boolean summarizeSuccesses)
public List<OperationResult> getSubresults()
OperationResult
.
public OperationResult getLastSubresult()
public void removeLastSubresult()
public OperationResultStatus getLastSubresultStatus()
public void addSubresult(OperationResult subresult)
public OperationResult findSubresult(String operation)
public OperationResultStatus getStatus()
OperationResultStatus
public void setStatus(OperationResultStatus status)
public boolean isSuccess()
public boolean isWarning()
public boolean isAcceptable()
public boolean isUnknown()
public boolean isInProgress()
public boolean isError()
public boolean isPartialError()
public boolean isHandledError()
public boolean isNotApplicable()
public void setErrorsHandled()
public void computeStatus(String errorMessage)
errorMessage
- error messagepublic void computeStatus(String errorMessage, String warnMessage)
public void computeStatus()
public OperationResultStatus getComputeStatus()
public void recomputeStatus()
public void recomputeStatus(String message)
public void recomputeStatus(String errorMessage, String warningMessage)
public void recordSuccessIfUnknown()
public Map<String,Object> getParams()
Map
with operation parameters. Parameters keys are
described in module interface for every operation.
public void addParam(String paramName, Object paramValue)
public void addParams(String[] names, Object... objects)
public Map<String,Object> getContext()
public <T> T getContext(Class<T> type, String contextName)
public void addContext(String contextName, Object value)
public Map<String,Object> getReturns()
public void addReturn(String returnName, Object value)
public Object getReturn(String returnName)
public long getToken()
public String getMessageCode()
public String getMessage()
public String getLocalizationMessage()
public List<Object> getLocalizationArguments()
public Throwable getCause()
public void recordSuccess()
public void recordInProgress()
public void recordUnknown()
public void recordFatalError(Throwable cause)
public void muteError()
public void muteLastSubresultError()
public void recordPartialError(Throwable cause)
public void recordWarning(Throwable cause)
public void recordStatus(OperationResultStatus status, Throwable cause)
public void recordFatalError(String message, Throwable cause)
public void recordPartialError(String message, Throwable cause)
public void recordWarning(String message, Throwable cause)
public void recordHandledError(String message)
public void recordStatus(OperationResultStatus status, String message, Throwable cause)
public void recordFatalError(String message)
public void recordPartialError(String message)
public void recordWarning(String message)
public void record(CommonException exception)
exception
- common exceptionpublic void recordStatus(OperationResultStatus status, String message)
public boolean hasUnknownStatus()
public void appendDetail(String detailLine)
public List<String> getDetail()
public String toString()
toString
in class Object
public static OperationResult createOperationResult(OperationResultType result)
public OperationResultType createOperationResultType()
public void summarize()
public String debugDump()
DebugDumpable
debugDump
in interface DebugDumpable
public String debugDump(int indent)
debugDump
in interface DebugDumpable
public String dump()
Dumpable
dump
in interface Dumpable
public String dump(boolean withStack)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |