Process API

filenet.vw.api
Class VWTransferResult

java.lang.Object
  extended by filenet.vw.api.VWTransferResult
All Implemented Interfaces:
java.io.Serializable

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

Use this class to access the value returned by a VWSession.transfer() method call.

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

// Initialize version and errors to null:

String myVersion = null;
string myError[] = null;

// Put result of transfer in tRes:

VWTransferResult tRes = mySession.transfer ( myWorkflow, "DLTestWorkflow", true, true );

// If the transfer was successful, return the version; otherwise return the errors that caused it to fail:

if (tRes.sucess())
myVersion = tRes.getVersion();
else
myError = tRes.getErrors();

Since:
VWWS3.10
See Also:
VWSession, VWSession.transfer(filenet.vw.api.VWWorkflowDefinition, java.lang.String, boolean, boolean), Serialized Form

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.
 java.lang.String[] getErrors()
          Retrieves the errors returned by a transfer operation.
 java.lang.String getVersion()
          Retrieves a string representation of the version returned by the transfer.
 boolean success()
          Determines whether a transfer 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

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


success

public boolean success()
Determines whether a transfer was successful.

Returns:
true if the transfer succeeded; otherwise, the method returns false.

getVersion

public java.lang.String getVersion()
Retrieves a string representation of the version returned by the transfer.

Returns:
The transfer version string or null if the transfer operation fails.

To retrieve the errors causing a failure, use the getErrors() method.


getErrors

public java.lang.String[] getErrors()
Retrieves the errors returned by a transfer operation.

Returns:
An array of strings. Each string represents an error message for each error encountered during the transfer operation. If the system completed the transfer operation successfully, the array will contain null values.

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.

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.