|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWValidationError
Use this class to access information about errors encountered during the workflow definition validation process.
Field Summary | |
static int |
VALIDATION_LEVEL_ERROR
Integer value of 1. A VWValidationError level value which indicates that a validation error WILL either cause transfer to fail or cause a problem at run-time. |
static int |
VALIDATION_LEVEL_WARNING
Integer value of 2. A VWValidationError level value which indicates that a validation error MAY either cause transfer to fail or cause a problem at run-time. |
static int |
VALIDATION_TYPE_FIELD
Integer value 4. Specifies that the validation item is a field. |
static int |
VALIDATION_TYPE_INSTRUCTION
Integer value 7. Specifies that the validation item is a instruction. |
static int |
VALIDATION_TYPE_MILESTONE
Integer value 8. Specifies that the validation item is a milestone. |
static int |
VALIDATION_TYPE_PARAMETER
Integer value 3. Specifies that the validation item is a parameter. |
static int |
VALIDATION_TYPE_ROUTE
Integer value 2. Specifies that the validation item is a route. |
static int |
VALIDATION_TYPE_STEP
Integer value of 1. Specifies that the validation item is a step. |
static int |
VALIDATION_TYPE_WORKFLOW
Integer value 6. Specifies that the validation item is a workflow. |
Method Summary | |
int |
getErrorType()
Retrieves the value in the errorType property of this validation error. |
int |
getId()
Deprecated. Replaced by getStepId() , VWMapDefinition.getMapId() , and getSubStepId() in
combination. For compatibility,
this method returns a Step ID, but
the use of sub-maps in the workflow definition
means that a Step ID alone is no longer sufficient to locate the
object causing a validation error.Note An error in a simple step requires the Step ID and the Map ID; an error in a compound step instruction requires a Map ID, a Step ID, and a sub-step ID. |
java.lang.String |
getInfo()
Retrieves detailed information regarding the validation error, such as the name of a field or a parameter. |
int |
getLevel()
Gets the value of the level property of the current validation error. |
java.lang.String |
getMapName()
Gets the value in the map name property of this validation error. |
java.lang.String |
getMessage()
Retrieves the value in the message property of this validation error. |
java.lang.String |
getName()
Gets the name of the object that contains the error. |
int |
getStepId()
Gets an integer value that is the step Id property of the current validation error. |
int |
getSubStepId()
Gets an integer value that is the Id property of the object that caused the current validation error, within the current step. |
java.lang.String |
toString()
Gets a string that represents this validation object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int VALIDATION_TYPE_STEP
public static final int VALIDATION_TYPE_ROUTE
public static final int VALIDATION_TYPE_PARAMETER
public static final int VALIDATION_TYPE_FIELD
public static final int VALIDATION_TYPE_WORKFLOW
public static final int VALIDATION_TYPE_INSTRUCTION
public static final int VALIDATION_TYPE_MILESTONE
public static final int VALIDATION_LEVEL_ERROR
public static final int VALIDATION_LEVEL_WARNING
Method Detail |
public java.lang.String getName()
public java.lang.String getInfo()
public java.lang.String getMessage()
public int getErrorType()
public int getLevel()
VALIDATION_LEVEL_ERROR
,
VALIDATION_LEVEL_WARNING
public int getId()
getStepId()
, VWMapDefinition.getMapId()
, and getSubStepId()
in
combination. For compatibility,
this method returns a Step ID, but
the use of sub-maps in the workflow definition
means that a Step ID alone is no longer sufficient to locate the
object causing a validation error.Note An error in a simple step requires the Step ID and the Map ID; an error in a compound step instruction requires a Map ID, a Step ID, and a sub-step ID.
getStepId()
,
VWMapDefinition.getMapId()
,
getSubStepId()
public java.lang.String getMapName()
VWWorkflowDefinition
,
getStepId()
,
getSubStepId()
public int getStepId()
VWMapDefinition.getMapId()
,
getSubStepId()
public int getSubStepId()
getStepId()
,
VWMapDefinition.getMapId()
public java.lang.String toString()
toString
in class java.lang.Object
<error type>:<object name>:<additional information>:<map ID>:<step ID>:<instruction ID>:<error message>
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |