VWCreateLiveWOResult (Process API Documentation)

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

All Implemented Interfaces:: java.io.Serializable

public final class VWCreateLiveWOResult
extends java.lang.Object
implements java.io.Serializable

Use this class to access the return value of a VWSession.createLiveWorkObject() method call.

The following code snippet demonstrates how to use this class in a general fashion:

Initialize work object numbers and roster names to null:

 String myWorkObjectNumbers[] = null;

 String myRosterNames[] = null;

Put the result of the VWSession.createLiveWorkObject() method call in createWORes:

 VWCreateLiveWOResult createWORes[] = mySession.createLiveWorkObject( myFieldNames, myFieldValues, myWorkflowId, numbertoCreate);

If the create was successful, retrieve and return the myWorkObjectNumbers and myRosterNames:

 if (createWORes.success()) {
 
 myWorkObjectNumbers = new String[createWORes.length]{

 myRosterNames = new String[createWORes.length] {

 for (int i=0; i<createWORes.length; ++i) {
     
 myWorkObjectNumbers[i] = createWORes.getWorkObjectNumber();

 myRosterNames[i] = createWORes.getRosterName();
     }
 }

Since:: eProcess 4.20
See Also:: VWSession, VWSession.createLiveWorkObject(java.lang.String[], java.lang.Object[], java.lang.String, int), Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getErrorTuple()` Determines whether a VWSession.createLiveWorkObject() method invocation had a server error.
`java.lang.String`	`getRosterName()` Retrieves a string representation of roster name returned by the VWSession.createLiveWorkObject method.
`java.lang.String`	`getWorkObjectNumber()` Retrieves a String representation of F_WobNum returned by the VWSession.createLiveWorkObject() method.
`boolean`	`success()` Determines whether a VWSession.createLiveWorkObject() method invocation was successful.
`java.lang.String`	`toString()` Retrieves the string version of this transfer result object.

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

- Method Detail
  - success
```
public boolean success()
```
    Determines whether a VWSession.createLiveWorkObject() method invocation was successful.
    
    Returns:
    
    A Boolean value. The method returns true if the transfer succeeded; otherwise, the method returns false.
  - getErrorTuple
```
public long getErrorTuple()
```
    Determines whether a VWSession.createLiveWorkObject() method invocation had a server error.
    
    Returns:
    
    A Boolean value. The method returns 0 if the transfer succeeded; otherwise, the method returns server error.
  - getWorkObjectNumber
```
public java.lang.String getWorkObjectNumber()
```
    Retrieves a String representation of F_WobNum returned by the VWSession.createLiveWorkObject() method.
    
    Returns:
    
    A String containing the work object number.
  - getRosterName
```
public java.lang.String getRosterName()
```
    Retrieves a string representation of roster name returned by the VWSession.createLiveWorkObject method. If a translation source exists, the authored roster name is translated.
    
    Returns:
    
    A String containing the translated roster name, if a translation source exists; otherwise the authored roster name is returned.
  - toString
```
public java.lang.String toString()
```
    Retrieves the string version of this transfer result object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string containing a text representation of the transfer result object.

Methods inherited from class java.lang.Object

success

getErrorTuple

getWorkObjectNumber

getRosterName

toString