|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWValidationError
public final class VWValidationError
Use this class to access information about errors encountered during the workflow definition validation process.
Field Summary | |
---|---|
static int |
VALIDATION_LEVEL_ERROR
Value of 1. Indicates that a validation error will either cause the transfer to fail or cause a problem at runtime. |
static int |
VALIDATION_LEVEL_WARNING
Value of 2. Indicates that a validation error may possibly either cause the transfer to fail or cause a problem at runtime. |
static int |
VALIDATION_TYPE_ANNOTATION
Integer value 12. Specifies that the validation item is a text annotation definition. |
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_PARTNERLINK
Integer value 10. Specifies that the validation item is a partnerlink. |
static int |
VALIDATION_TYPE_ROUTE
Integer value 2. Specifies that the validation item is a route. |
static int |
VALIDATION_TYPE_RULESET
Integer value 9. Specifies that the validation item is a ruleset. |
static int |
VALIDATION_TYPE_SCHEMA
Integer value 11. Specifies that the validation item is a schema definition. |
static int |
VALIDATION_TYPE_STEP
Value of 1. |
static int |
VALIDATION_TYPE_WORKFLOW
Integer value 6. Specifies that the validation item is a workflow. |
static int |
VALIDATION_TYPE_WORKFLOW_COLLECTION
Integer value 13. Specifies that the validation item is a workflow collection. |
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
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.
Gets the value in the ID property of this validation error. |
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 instance. |
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 representing the step ID property of the current validation error. |
int |
getSubStepId()
Gets an integer representing the ID property of the object that caused the current validation error within the current step. |
java.lang.String |
toString()
Returns a String representing this instance. |
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_TYPE_RULESET
public static final int VALIDATION_TYPE_PARTNERLINK
public static final int VALIDATION_TYPE_SCHEMA
public static final int VALIDATION_TYPE_ANNOTATION
public static final int VALIDATION_TYPE_WORKFLOW_COLLECTION
public static final int VALIDATION_LEVEL_ERROR
public static final int VALIDATION_LEVEL_WARNING
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
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.
Gets the value in the ID property of this 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()
If the error type is VALIDATION_TYPE_ANNOTATION, this method will return the annotation id. The Map ID will be required in order to locate the invalid annotation.>/p>
VWMapDefinition.getMapId()
,
getSubStepId()
public int getSubStepId()
Locating the invalid substep object (a VWInstructionDefinition or a
VWRouteDefinition) requires the Step ID and the Map ID.
You can get these IDs with getStepID
and
VWMapDefinition.getMapId
.
getStepId()
,
VWMapDefinition.getMapId()
public java.lang.String toString()
toString
in class java.lang.Object
<error type>:<error level>:<object name>:<additional information>:<map ID>:<step ID>:<instruction ID>:<error message>
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |