public class OperationResult extends Object implements Serializable, DebugDumpable, ShortDumpable, Cloneable
Modifier and Type | Field and Description |
---|---|
static String |
CONTEXT_IMPLEMENTATION_CLASS |
static String |
CONTEXT_ITEM |
static String |
CONTEXT_OBJECT |
static String |
CONTEXT_OID |
static String |
CONTEXT_PROGRESS |
static String |
CONTEXT_RESOURCE |
static String |
CONTEXT_TASK |
static String |
PARAM_LANGUAGE |
static String |
PARAM_NAME |
static String |
PARAM_OBJECT |
static String |
PARAM_OID |
static String |
PARAM_OPTIONS |
static String |
PARAM_PROJECTION |
static String |
PARAM_QUERY |
static String |
PARAM_TASK |
static String |
PARAM_TYPE |
static String |
RETURN_BACKGROUND_TASK_OID |
static String |
RETURN_COUNT |
finalize, getClass, notify, notifyAll, wait, wait, wait
debugDump, debugDumpLazily, debugDumpLazily
shortDump, shortDumpLazily
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 CONTEXT_RESOURCE
public static final String PARAM_OID
public static final String PARAM_NAME
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 PARAM_QUERY
public static final String PARAM_PROJECTION
public static final String PARAM_LANGUAGE
public static final String RETURN_COUNT
public static final String RETURN_BACKGROUND_TASK_OID
public OperationResult(String operation)
public OperationResult(String operation, OperationResultStatus status, LocalizableMessage userFriendlyMessage)
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,Collection<String>> params, OperationResultStatus status, long token, String messageCode, String message)
public OperationResult(String operation, Map<String,Collection<String>> params, OperationResultStatus status, long token, String messageCode, String message, List<OperationResult> subresults)
public OperationResult(String operation, Map<String,Collection<String>> params, OperationResultStatus status, long token, String messageCode, String message, LocalizableMessage userFriendlyMessage, Throwable cause, List<OperationResult> subresults)
public OperationResult(String operation, Map<String,Collection<String>> params, Map<String,Collection<String>> context, Map<String,Collection<String>> returns, OperationResultStatus status, long token, String messageCode, String message, LocalizableMessage userFriendlyMessage, Throwable cause, List<OperationResult> subresults)
public static OperationResult keepRootOnly(OperationResult result)
public OperationResult keepRootOnly()
public OperationResult createSubresult(String operation)
public OperationResult createMinorSubresult(String operation)
public String getAsynchronousOperationReference()
public void setAsynchronousOperationReference(String asynchronousOperationReference)
public String findAsynchronousOperationReference()
public boolean isTaskOid(String ref)
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 int getHiddenRecordsCount()
public void setHiddenRecordsCount(int hiddenRecordsCount)
public boolean representsHiddenRecords()
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 boolean isEmpty()
@NotNull 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 List<OperationResult> findSubresults(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 isFatalError()
public boolean isPartialError()
public boolean isHandledError()
public boolean isNotApplicable()
public void setErrorsHandled()
public void computeStatus(String errorMessage)
errorMessage
- error messagepublic void computeStatus()
public void computeStatusComposite()
public OperationResultStatus getComputeStatus()
public void computeStatusIfUnknown()
public void recomputeStatus()
public void recomputeStatus(String message)
public void recordSuccessIfUnknown()
public void recordNotApplicableIfUnknown()
public boolean isMinor()
public Map<String,Collection<String>> getParams()
Map
with operation parameters. Parameters keys are
described in module interface for every operation.public Collection<String> getParam(String name)
public void addParam(String name, PrismObject<? extends ObjectType> value)
public void addParam(String name, ObjectType value)
public void addParam(String name, boolean value)
public void addParam(String name, long value)
public void addParam(String name, int value)
public void addParam(String name, PolyString value)
public void addParam(String name, ObjectQuery value)
public void addParam(String name, ObjectDelta<?> value)
public void addArbitraryObjectAsParam(String paramName, Object paramValue)
public void addArbitraryObjectCollectionAsParam(String name, Collection<?> value)
public Map<String,Collection<String>> getContext()
public void addContext(String name, PrismObject<? extends ObjectType> value)
public void addContext(String name, ObjectType value)
public void addContext(String name, boolean value)
public void addContext(String name, long value)
public void addContext(String name, int value)
public void addContext(String name, PolyString value)
public void addContext(String name, ObjectQuery value)
public void addContext(String name, ObjectDelta<?> value)
public void addArbitraryObjectCollectionAsContext(String paramName, Collection<?> paramValue)
public Map<String,Collection<String>> getReturns()
public Collection<String> getReturn(String name)
public void addReturn(String name, PrismObject<? extends ObjectType> value)
public void addReturn(String name, ObjectType value)
public void addReturn(String name, boolean value)
public void addReturn(String name, long value)
public void addReturn(String name, int value)
public void addReturn(String name, PolyString value)
public void addReturn(String name, ObjectQuery value)
public void addReturn(String name, ObjectDelta<?> value)
public void addArbitraryObjectCollectionAsReturn(String paramName, Collection<?> paramValue)
public long getToken()
public String getMessageCode()
public String getMessage()
public void setMessage(String message)
public LocalizableMessage getUserFriendlyMessage()
public void setUserFriendlyMessage(LocalizableMessage userFriendlyMessage)
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 deleteLastSubresultIfError()
public void recordPartialError(Throwable cause)
public void recordWarning(Throwable cause)
public void recordStatus(OperationResultStatus status, Throwable cause)
public void recordHandledError(String message)
public void recordHandledError(Throwable cause)
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 static OperationResult createOperationResult(OperationResultType result) throws SchemaException
SchemaException
public OperationResultType createOperationResultType()
public OperationResultType createOperationResultType(Function<LocalizableMessage,String> resolveKeys)
public void summarize()
public void summarize(boolean alsoSubresults)
public void cleanupResultDeeply()
public void cleanupResult()
public void cleanupResult(Throwable e)
public String debugDump(int indent)
debugDump
in interface DebugDumpable
public String dump(boolean withStack)
public void shortDump(StringBuilder sb)
ShortDumpable
shortDump
in interface ShortDumpable
sb
- StringBuilder to which to a compact one-line content of the object intended
for diagnostics by system administrator should be appended.public void setBackgroundTaskOid(String oid)
@Deprecated public String getBackgroundTaskOid()
public void setMinor(boolean value)
public void recordThrowableIfNeeded(Throwable t)
public static OperationResult createSubResultOrNewResult(OperationResult parentResult, String operation)
public OperationResult clone()
public static int getSubresultStripThreshold()
public static void setSubresultStripThreshold(Integer value)
Copyright © 2019 Evolveum. All rights reserved.