Process Java API: VWReturnStackElement (Process API Documentation)

Skip navigation links

Process API

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- filenet.vw.api.VWReturnStackElement

All Implemented Interfaces:

java.io.Serializable
```
public final class VWReturnStackElement
extends java.lang.Object
implements java.io.Serializable
```
Encapsulates a stack frame object for a work object, containing map and step identification and error description information.

Since:

eP6.0

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getErrorMessageText()` Gets the error message text for this stack object.
`java.lang.String`	`getErrorNumber()` Gets the error number for this stack object.
`int`	`getMapId()` Gets the ID of the map for this stack object.
`java.lang.String`	`getMapName()` Gets the name of the map for this stack object.
`int`	`getStepId()` Gets the ID of the step for this stack object.
`java.lang.String`	`getStepName()` Gets the name of the step for this stack object.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getMapName
```
public java.lang.String getMapName()
```
    Gets the name of the map for this stack object. If a translation source exists, the authored name is translated.
    
    Returns:
    A String containing the translated map name, if a translation source exists; otherwise the authored name is returned.
  - getMapId
```
public int getMapId()
```
    Gets the ID of the map for this stack object.
    
    Returns:
    ID of the map for this stack object.
  - getStepName
```
public java.lang.String getStepName()
```
    Gets the name of the step for this stack object. If a translation source exists, the authored name is translated.
    
    Returns:
    A String containing the translated step name, if a translation source exists; otherwise the authored name is returned.
  - getStepId
```
public int getStepId()
```
    Gets the ID of the step for this stack object.
    
    Returns:
    ID of the step for this stack object.
  - getErrorNumber
```
public java.lang.String getErrorNumber()
```
    Gets the error number for this stack object.
    
    Returns:
    Error number for this stack object.
  - getErrorMessageText
```
public java.lang.String getErrorMessageText()
```
    Gets the error message text for this stack object.
    
    Returns:
    Error message text for this stack object.