ch.ivyteam.ivy.bpm.error

Class BpmError

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

ch.ivyteam.util.IvyRuntimeException

ch.ivyteam.ivy.bpm.error.BpmError

public class BpmError
extends IvyRuntimeException

Provides information about an error that occured in the process.

Use BpmError.create(String) to create or throw a new BpmError.

See Also:

Serialized Form

API:

This is a public API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BpmError.AttributeNames Defines names of attributes that are available on errors with certain error codes

Method Summary

Modifier and Type	Method and Description
static BpmPublicErrorBuilder	create(BpmError errorCause) To create a new error with the given errorCause
static BpmPublicErrorBuilder	create(String errorCode) To create a new error with the given errorCode
Object	getAttribute(String name) Error attributes can be used to provide more information about the error. The attributes can be use to format the default error message and error messages.
Set<String>	getAttributeNames() Error attributes can be used to provide more information about the error. The attributes can be use to format the default error message and error messages.
Throwable	getCause() Returns the cause of this error.
BpmError	getErrorCause() Returns the error cause of the error.
String	getErrorCode() The error code is used to identify different kind of business errors.
String	getErrorMessage() Returns the error message of this error.
String	getErrorMessage(String messageName) Returns the specific message with the given messageName of this error.
String	getId() A unique error id.
String	getMessage() Returns the message of this error.
List<BpmStackFrame>	getProcessCallStack() The process call stack at the moment the error was thrown. The process call stack is empty if the error was thrown in a top level process.
BpmProcessElement	getProcessElement() The process element that threw (caused) the error.
Throwable	getTechnicalCause() Returns the technical cause of the error.
void	setAttribute(String name, Object value) Error attributes can be used to add more information about the error. The attributes can be use to format the default error message and error messages.

Method Detail

create

public static BpmPublicErrorBuilder create(String errorCode)

To create a new error with the given errorCode

Examples:
BpmError.create("finance:nomoney").build()
BpmError.create("finance:nomoney").withMessage("There is no money left").build()

Parameters:

errorCode -

Returns:

error builder

See Also:

BpmError.create(BpmError), BpmError.getErrorCode()

API:

This public API is available in IvyScript and Java. It has the visibility NOVICE.

create

public static BpmPublicErrorBuilder create(BpmError errorCause)

To create a new error with the given errorCause

Examples:

 BpmError errorCause = in.error;
 BpmError.create(errorCause).build();
 

 BpmError errorCause = in.error;
 BpmError.create(errorCause).withErrorCode("finance:nomoney").withMessage("There is no money left").build();
 

Parameters:

errorCause -

Returns:

error builder

See Also:

BpmError.create(String), BpmError.getErrorCause(), BpmErrorBuilder.withErrorCode(String)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getId

public String getId()

A unique error id. Can be used to find more information about the error in the logs.

Overrides:

getId in class IvyRuntimeException

Returns:

error id

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getErrorCode

public String getErrorCode()

The error code is used to identify different kind of business errors. Error handlers use the error code to specify for which errors they are responsible for.

Returns:

error code

See Also:

BpmErrorBuilder.withErrorCode(String)

API:

This public API is available in IvyScript and Java. It has the visibility NOVICE.

getTechnicalCause

public Throwable getTechnicalCause()

Returns the technical cause of the error.

Returns:

Java exception that triggered the error handling. Maybe null.

See Also:

BpmError.getErrorCause(), BpmError.getCause(), BpmErrorBuilder.withCause(Throwable)

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

getErrorCause

public BpmError getErrorCause()

Returns the error cause of the error.

Returns:

the error that was the cause of this error. Maybe null.

See Also:

BpmError.getTechnicalCause(), BpmError.getCause(), BpmErrorBuilder.withCause(Throwable)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getCause

public Throwable getCause()

Returns the cause of this error.

This is either the BpmError.getErrorCause() or the BpmError.getTechnicalCause() or null.

Overrides:

getCause in class Throwable

See Also:

Throwable.getCause(), BpmError.getErrorCause(), BpmError.getTechnicalCause()

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

setAttribute

public void setAttribute(String name,
                         Object value)

Error attributes can be used to add more information about the error.
The attributes can be use to format the default error message and error messages.

Parameters:

name -

value -

See Also:

BpmError.getAttribute(String), BpmError.getMessage(), BpmError.getErrorMessage(), BpmError.getErrorMessage(String), BpmErrorBuilder.withAttribute(Object), BpmErrorBuilder.withAttribute(String, Object), BpmErrorBuilder.withAttributes(Map)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getAttribute

public Object getAttribute(String name)

Error attributes can be used to provide more information about the error.
The attributes can be use to format the default error message and error messages.

See BpmError.AttributeNames for attributes that are available on errors provided by the system.

Parameters:

name -

Returns:

attribute value or null

See Also:

BpmError.setAttribute(String, Object), BpmError.getMessage(), BpmError.getErrorMessage(), BpmError.getErrorMessage(String), BpmErrorBuilder.withAttribute(Object), BpmErrorBuilder.withAttribute(String, Object), BpmErrorBuilder.withAttributes(Map), BpmError.AttributeNames

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getAttributeNames

public Set<String> getAttributeNames()

Error attributes can be used to provide more information about the error.
The attributes can be use to format the default error message and error messages.

See BpmError.AttributeNames for attributes that are available on errors provided by the system.

Returns:

set with all names of available attributes.

See Also:

BpmError.setAttribute(String, Object), BpmError.getAttribute(String), BpmErrorBuilder.withAttribute(Object), BpmErrorBuilder.withAttribute(String, Object), BpmErrorBuilder.withAttributes(Map), BpmError.AttributeNames

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getMessage

public String getMessage()

Returns the message of this error.

Use BpmError.getErrorMessage() to get a localized message for the end user.

The message can be given when creating the error (see BpmErrorBuilder.withMessage(String)) if not specified it is the BpmError.getErrorCode().

Any attribute placeholder ({0}, {1}, etc) in the message are replaced with the corresponding attributes.

Overrides:

getMessage in class Throwable

See Also:

BpmErrorBuilder.withMessage(String), BpmError.getErrorMessage(), BpmError.getErrorMessage(String), BpmErrorBuilder.withMessage(String), BpmErrorBuilder.withCause(Throwable), BpmError.setAttribute(String, Object), BpmError.getAttribute(String), BpmErrorBuilder.withAttribute(Object), BpmErrorBuilder.withAttribute(String, Object)

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getErrorMessage

public String getErrorMessage()

Returns the error message of this error.

The error message is intended to be displayed to the end user. Therefore the error message for an error is normally stored in the CMS so that it can be translated to different languages.

For an error with the error code ivy:error:database the error message is searched in the CMS in the following order and paths:

1. /Errors/ivy/error/database/message
2. /Errors/ivy/error/database
3. /Errors/ivy/error/message
4. /Errors/ivy/error
5. /Errors/ivy/message
6. /Errors/ivy

If no error message is found in the CMS the errorCode and if available the message of the technical cause is returned instead.

Any attribute placeholder ({0}, {1}, etc) in the message are replaced with the corresponding attributes.

Returns:

error message

See Also:

BpmError.getMessage(), BpmError.getErrorMessage(String), BpmError.setAttribute(String, Object), BpmError.getAttribute(String), BpmErrorBuilder.withAttribute(Object), *

API:

This public API is available in IvyScript and Java. It has the visibility NOVICE.

getErrorMessage

public String getErrorMessage(String messageName)

Returns the specific message with the given messageName of this error. For example a help or a how to proceed text.

The specific message is intended to be displayed to the end user. Therefore specific messages for an error is normally stored in the CMS so that it can be translated to different languages.

For an error with the error code ivy:error:database and the messageName help the error message is searched in the CMS in the following order and paths:

1. /Errors/ivy/error/database/help
2. /Errors/ivy/error/help
3. /Errors/ivy/help

If no error message is found in the CMS an empty string is returned instead.

Any attribute placeholder ({0}, {1}, etc) in the message are replaced with the corresponding attributes.

Parameters:

messageName - the name of the message to return

Returns:

error message with the given messageName

See Also:

BpmError.getMessage(), BpmError.getErrorMessage(), BpmError.setAttribute(String, Object), BpmError.getAttribute(String), BpmErrorBuilder.withAttribute(Object), BpmErrorBuilder.withAttribute(String, Object)

API:

This public API is available in IvyScript and Java. It has the visibility NOVICE.

getProcessElement

public BpmProcessElement getProcessElement()

The process element that threw (caused) the error.

Returns:

process element

API:

This public API is available in IvyScript and Java. It has the visibility NOVICE.

getProcessCallStack

public List<BpmStackFrame> getProcessCallStack()

The process call stack at the moment the error was thrown.
The process call stack is empty if the error was thrown in a top level process. If it was thrown in a callable process it contains all caller process elements.

Returns:

process call stack. Maybe empty. Never null.

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.