Package com.tibco.ep.tcs.runtime

Class FlowValidationProblem

java.lang.Object

com.tibco.ep.tcs.runtime.FlowValidationProblem

public class FlowValidationProblem
extends Object

A container for a single flow validation error or warning.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlowValidationProblem.EntityType	Entity type.
static class	FlowValidationProblem.ProblemType	Problem type.
static class	FlowValidationProblem.SeverityLevel	Problem severity level.

Constructor Summary

Constructors

Constructor	Description
FlowValidationProblem(FlowValidationProblem.SeverityLevel severityLevel, FlowValidationProblem.ProblemType type, FlowValidationProblem.EntityType entityType, String entityName, String location, String description)	Create a new validation problem associated with a TCS flow entity.
FlowValidationProblem(FlowValidationProblem.SeverityLevel severityLevel, FlowValidationProblem.ProblemType type, String location, String description)	Create a new validation problem not associated with a TCS flow entity.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return this problem's description.
String	getEntityName()	Name of the entity that caused the problem, null if unknown.
FlowValidationProblem.EntityType	getEntityType()	The entity type that caused the problem, Unknown if unknown.
String	getLocation()	Return this problem's location, null if unknown or not relevant.
FlowValidationProblem.SeverityLevel	getSeverityLevel()	Return this problem's severity level.
FlowValidationProblem.ProblemType	getType()	Return this problem's type
String	toString()	Format the problem in a human-readable line of text.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowValidationProblem

public FlowValidationProblem(FlowValidationProblem.SeverityLevel severityLevel,
                             FlowValidationProblem.ProblemType type,
                             String location,
                             String description)

Create a new validation problem not associated with a TCS flow entity. Entity type is unknown, entity name is null.

Parameters:

severityLevel - problem severity level

type - problem type

location - problem location

description - description of the problem

FlowValidationProblem

public FlowValidationProblem(FlowValidationProblem.SeverityLevel severityLevel,
                             FlowValidationProblem.ProblemType type,
                             FlowValidationProblem.EntityType entityType,
                             String entityName,
                             String location,
                             String description)

Create a new validation problem associated with a TCS flow entity.

Parameters:

severityLevel - problem severity level

type - problem type

entityType - type of TCS flow entity causing the problem, FlowValidationProblem.EntityType.Unknown if unknown

entityName - name of TCS entity causing the problem, null if unknown

location - problem location, null if not relevant

description - description of the problem

Method Detail

getSeverityLevel

public FlowValidationProblem.SeverityLevel getSeverityLevel()

Return this problem's severity level.

Returns:

the level

getType

public FlowValidationProblem.ProblemType getType()

Return this problem's type

Returns:

the type

getEntityType

public FlowValidationProblem.EntityType getEntityType()

The entity type that caused the problem, Unknown if unknown.

Returns:

the type

getEntityName

public String getEntityName()

Name of the entity that caused the problem, null if unknown.

Returns:

the name

getLocation

public String getLocation()

Return this problem's location, null if unknown or not relevant.

Returns:

the location

getDescription

public String getDescription()

Return this problem's description.

Returns:

the description

toString

public String toString()

Format the problem in a human-readable line of text.

Overrides:

toString in class Object

Returns:

formatted text