@Transactional(propagation=SUPPORTS,
readOnly=true)
public interface ErrorDocumentService
Modifier and Type | Method and Description |
---|---|
boolean |
delete(T2Reference reference) |
void |
deleteErrorDocumentsForWorkflowRun(String workflowRunId)
Delete all
ErrorDocument S used by the specific workflow run. |
T2Reference |
getChild(T2Reference errorId)
Return the T2Reference for the sole child of an error document
identifier.
|
ErrorDocument |
getError(T2Reference id)
Retrieve a previously named and registered ErrorDocument from the backing
store
|
void |
getErrorAsynch(T2Reference id,
ErrorDocumentServiceCallback callback)
Functionality the same as
getError but in
asynchronous mode, returning immediately and using the supplied callback
to communicate its results. |
ErrorDocument |
registerError(String message,
int depth,
ReferenceContext context)
Equivalent to
registerError(message, null, depth, context) . |
ErrorDocument |
registerError(String message,
Set<T2Reference> errors,
int depth,
ReferenceContext context)
Register a new error document.
|
ErrorDocument |
registerError(String message,
Throwable t,
int depth,
ReferenceContext context)
Register a new error document.
|
ErrorDocument |
registerError(Throwable t,
int depth,
ReferenceContext context)
Equivalent to
registerError("", t, depth, context) . |
@Transactional(propagation=REQUIRED, readOnly=false) ErrorDocument registerError(String message, Throwable t, int depth, ReferenceContext context) throws ErrorDocumentServiceException
The created reference will be related with a workflow run id passed through ReferenceContext so we can track all data referenced by a specific run.
message
- a free text message describing the error, if available. If
there is no message use the empty string here.t
- a Throwable describing the underlying fault causing this error
document to be registered, if any. If there is no Throwable
associated use null.depth
- depth of the error, used when returning an error document
instead of an identified list.ErrorDocumentServiceException
@Transactional(propagation=REQUIRED, readOnly=false) ErrorDocument registerError(String message, int depth, ReferenceContext context) throws ErrorDocumentServiceException
registerError(message, null, depth, context)
.ErrorDocumentServiceException
@Transactional(propagation=REQUIRED, readOnly=false) ErrorDocument registerError(Throwable t, int depth, ReferenceContext context) throws ErrorDocumentServiceException
registerError("", t, depth, context)
.ErrorDocumentServiceException
@Transactional(propagation=REQUIRED, readOnly=false) ErrorDocument registerError(String message, Set<T2Reference> errors, int depth, ReferenceContext context) throws ErrorDocumentServiceException
The created reference will be related with a workflow run id passed through ReferenceContext so we can track all data referenced by a specific run.
message
- a free text message describing the error, if available. If
there is no message use the empty string here.errors
- a set of references that contain error documents.depth
- depth of the error, used when returning an error document
instead of an identified list.ErrorDocumentServiceException
ErrorDocument getError(T2Reference id) throws ErrorDocumentServiceException
id
- identifier of the error document to retrieveErrorDocumentServiceException
- if anything goes wrong with the retrieval process or if there
is something wrong with the reference (such as it being of
the wrong reference type).void getErrorAsynch(T2Reference id, ErrorDocumentServiceCallback callback) throws ErrorDocumentServiceException
getError
but in
asynchronous mode, returning immediately and using the supplied callback
to communicate its results.id
- a T2Reference
identifying an ErrorDocument
to
retrievecallback
- a ErrorDocumentServiceCallback
used to convey the
results of the asynchronous callErrorDocumentServiceException
- if the reference set service is not correctly configured.
Exceptions encountered when performing the asynchronous call
are not returned here, for obvious reasons, and are instead
messaged through the callback interface.T2Reference getChild(T2Reference errorId) throws ErrorDocumentServiceException
ErrorDocumentServiceException
@Transactional(propagation=SUPPORTS, readOnly=false) boolean delete(T2Reference reference) throws ReferenceServiceException
ReferenceServiceException
@Transactional(propagation=SUPPORTS, readOnly=false) void deleteErrorDocumentsForWorkflowRun(String workflowRunId) throws ReferenceServiceException
ErrorDocument
S used by the specific workflow run.ReferenceServiceException
Copyright © 2015–2016 The Apache Software Foundation. All rights reserved.