com.inubit.research.validation

Class ValidationMessage

java.lang.Object

com.inubit.research.validation.ValidationMessage

public class ValidationMessage
extends java.lang.Object

This class is used for informing about any problem, that was found when validating a model.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_ERROR
static int	TYPE_INFO
static int	TYPE_WARNING

Constructor Summary

Constructors

Constructor and Description
ValidationMessage(int type, java.lang.String description, java.lang.String shortDescription, java.util.Collection<ProcessObject> involvedObjects)
ValidationMessage(int type, java.lang.String description, java.lang.String shortDescription, java.util.Collection<ProcessObject> involvedObjects, ProcessObject primaryObject)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() getter for the long version of this problem´s description
java.util.Collection<ProcessObject>	getInvolvedObjects() getter for the collection of the objects, that are related to this problem
java.lang.String	getInvolvedObjectsString()
ProcessObject	getPrimaryObject()
java.util.List<java.lang.String>	getRelatedEdgeIDs()
java.util.List<java.lang.String>	getRelatedNodeIDs()
java.lang.String	getShortDescription() getter for the short version of this problem´s description (suitable e.g.
int	getType() getter for the type of this problem.
java.lang.String	getTypeString()
boolean	hasPrimaryObject()
boolean	isError() returns, whether this is an error message
boolean	isInformation() returns, whether this is an information message
boolean	isWarning() returns, whether this is a warning message
void	setDescription(java.lang.String description) sets the long version of this problem´s description
void	setInvolvedObjects(java.util.Collection<ProcessObject> involvedObjects) sets the involved objects to the elements of the provided collection
void	setShortDescription(java.lang.String shortDescription) sets the short version of this problem´s description (should be suitable as a title in a problem list or similiar things)
void	setType(int type) sets the type of message, which this object represents (information, warning or error)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_INFO

public static final int TYPE_INFO

See Also:

Constant Field Values

TYPE_WARNING

public static final int TYPE_WARNING

See Also:

Constant Field Values

TYPE_ERROR

public static final int TYPE_ERROR

See Also:

Constant Field Values

Constructor Detail

ValidationMessage

public ValidationMessage(int type,
                         java.lang.String description,
                         java.lang.String shortDescription,
                         java.util.Collection<ProcessObject> involvedObjects,
                         ProcessObject primaryObject)

ValidationMessage

public ValidationMessage(int type,
                         java.lang.String description,
                         java.lang.String shortDescription,
                         java.util.Collection<ProcessObject> involvedObjects)

Method Detail

getType

public int getType()

getter for the type of this problem. Possible values are TYPE_INFO, TYPE_WARNING and TYPE_ERROR

Returns:

the type of validation message (information, warning or error)

getTypeString

public java.lang.String getTypeString()

isError

public boolean isError()

returns, whether this is an error message

Returns:

true, iff getType() == TYPE_ERROR

isWarning

public boolean isWarning()

returns, whether this is a warning message

Returns:

true, iff getType() == TYPE_WARNING

isInformation

public boolean isInformation()

returns, whether this is an information message

Returns:

true, iff getType() == TYPE_INFO

setType

public void setType(int type)

sets the type of message, which this object represents (information, warning or error)

Parameters:

type - the type to set (user TYPE_INFO, TYPE_WARNING or TYPE_ERROR)

getDescription

public java.lang.String getDescription()

getter for the long version of this problem´s description

Returns:

the long description

setDescription

public void setDescription(java.lang.String description)

sets the long version of this problem´s description

Parameters:

description - the description to set

getShortDescription

public java.lang.String getShortDescription()

getter for the short version of this problem´s description (suitable e.g. as a title in a list of problems)

Returns:

the short description

setShortDescription

public void setShortDescription(java.lang.String shortDescription)

sets the short version of this problem´s description (should be suitable as a title in a problem list or similiar things)

Parameters:

shortDescription - the shortDescription to set

getInvolvedObjects

public java.util.Collection<ProcessObject> getInvolvedObjects()

getter for the collection of the objects, that are related to this problem

Returns:

the involvedObjects

setInvolvedObjects

public void setInvolvedObjects(java.util.Collection<ProcessObject> involvedObjects)

sets the involved objects to the elements of the provided collection

getInvolvedObjectsString

public java.lang.String getInvolvedObjectsString()

getRelatedNodeIDs

public java.util.List<java.lang.String> getRelatedNodeIDs()

getRelatedEdgeIDs

public java.util.List<java.lang.String> getRelatedEdgeIDs()

getPrimaryObject

public ProcessObject getPrimaryObject()

hasPrimaryObject

public boolean hasPrimaryObject()