Package com.aquima.interactions.composer.model

Class FailedElement

java.lang.Object

com.aquima.interactions.composer.model.Element

com.aquima.interactions.composer.model.CompositeElement

com.aquima.interactions.composer.model.Container

com.aquima.interactions.composer.model.FailedElement

All Implemented Interfaces:

ICompositeElement, IContainer, IElement, Serializable

public class FailedElement
extends Container

This class element is used to represent an element that failed expansion. The main reason for this class is to provide feedback to the client that an element is present, but can't be displayed due to an error.

Since:

5.0

Author:

O. Kerpershoek

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.aquima.interactions.composer.model.Element

name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FailedElement(FailedElement other)
	FailedElement(Throwable error, String name, ElementType type)	Constructs a failed element with the cause of the failure and the name and type of the element that failed expansion.
	FailedElement(Throwable error, String name, ElementType type, IParameters parameters)	Constructs a failed element with the cause of the failure, the name and type of the element that failed expansion, and an object containing additional parameters to identify the failure.
	FailedElement(Throwable error, String name, ElementType type, IMultilingualText message)	Constructs a failed element with the cause of the failure, the name and type of the element that failed expansion, and a message explaining the cause of the failure.
	FailedElement(Throwable error, String name, ElementType type, String message)	Constructs a failed element with the cause of the failure, the name and type of the element that failed expansion, and a message explaining the cause of the failure.

Method Summary

Modifier and Type	Method	Description
Element	duplicate()	This method duplicates the container element.
IMultilingualText	getMessage()	This method returns the message explaining the failure.
IParameters	getParameters()	This method returns an object containing additional parameters that help identify the cause of the failure.
String	getStackTrace()	This method returns the stack trace of the failure.
ElementType	getType()	This method returns the type of the element that failed expansion.
boolean	isVisible()	This method returns a boolean indicating if the element should be visible.
String	toString()

Methods inherited from class com.aquima.interactions.composer.model.Container

addMessage, clearMessages, collectMessages, equals, getDisplayText, getEntityInstanceId, getMessages, getProperty, getReferenceAttribute, getTypeName, hashCode, setDisplayText, setEntityContext, setProperty, setReferenceAttribute, setTypeName

Methods inherited from class com.aquima.interactions.composer.model.CompositeElement

accept, addElement, addElements, equalsContent, getContentStyle, getElement, getElement, getElementCount, getElements, insertElement, removeAllElements, removeElement, replaceElementWithElements, setContentStyle, setElements

Methods inherited from class com.aquima.interactions.composer.model.Element

addPresentationStyle, evaluateTsl, getName, getParent, getPresentationStyles, getPropertyKeys, getRuntimeKey, getVisibilityCondition, hasFocus, hasPresentationStyle, isReadonly, isReadonlyInheritFromParent, setFocus, setParent, setPresentationStyle, setPresentationStyles, setPresentationStyles, setReadonly, setReadonlyInheritFromParent, setRuntimeKey, setVisibilityCondition, setVisible

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.aquima.interactions.composer.ICompositeElement

accept, equalsContent, getContentStyle, getElement, getElement, getElementCount, getElements

Methods inherited from interface com.aquima.interactions.composer.IElement

getName, getParent, getPresentationStyles, getPropertyKeys, getRuntimeKey, hasFocus, hasPresentationStyle, isReadonly, isReadonlyInheritFromParent

Constructor Details

FailedElement

protected FailedElement(FailedElement other)

FailedElement

public FailedElement(Throwable error,
 String name,
 ElementType type)

Constructs a failed element with the cause of the failure and the name and type of the element that failed expansion.

Parameters:

error - The cause of the failure.

name - The name of the element that failed expansion.

type - The type of the element that failed expansion.

FailedElement

public FailedElement(Throwable error,
 String name,
 ElementType type,
 String message)

Constructs a failed element with the cause of the failure, the name and type of the element that failed expansion, and a message explaining the cause of the failure.

Parameters:

error - The cause of the failure.

name - The name of the element that failed expansion.

type - The type of the element that failed expansion.

message - A message explaining the cause of the failure.

FailedElement

public FailedElement(Throwable error,
 String name,
 ElementType type,
 IMultilingualText message)

Constructs a failed element with the cause of the failure, the name and type of the element that failed expansion, and a message explaining the cause of the failure.

Parameters:

error - The cause of the failure.

name - The name of the element that failed expansion.

type - The type of the element that failed expansion.

message - A message explaining the cause of the failure.

FailedElement

public FailedElement(Throwable error,
 String name,
 ElementType type,
 IParameters parameters)

Constructs a failed element with the cause of the failure, the name and type of the element that failed expansion, and an object containing additional parameters to identify the failure.

Parameters:

error - The cause of the failure.

name - The name of the element that failed expansion.

type - The type of the element that failed expansion.

parameters - an object containing additional parameters that help identify the cause of the failure.

Method Details

duplicate

public Element duplicate()

Description copied from class: Container

This method duplicates the container element.

Specified by:

duplicate in interface IElement

Overrides:

duplicate in class Container

Returns:

A clone of this element.

getType

public ElementType getType()

This method returns the type of the element that failed expansion.

Returns:

the type of the element that failed expansion.

getMessage

public IMultilingualText getMessage()

This method returns the message explaining the failure.

Returns:

the message explaining the failure.

getParameters

public IParameters getParameters()

This method returns an object containing additional parameters that help identify the cause of the failure.

Returns:

an object containing additional parameters that help identify the cause of the failure.

getStackTrace

public String getStackTrace()

This method returns the stack trace of the failure.

Returns:

the stack trace of the failure.

isVisible

public boolean isVisible()

Description copied from interface: IElement

This method returns a boolean indicating if the element should be visible. An element is visible when the element itself is specified as being visible and the parent container (if available) is visible.

Specified by:

isVisible in interface IElement

Overrides:

isVisible in class Element

Returns:

boolean indicating if the element should be visible.

toString

public String toString()

Overrides:

toString in class Container