Process Class Relationships

filenet.vw.api
Class VWStepProcessorInfo

java.lang.Object
  |
  +--filenet.vw.api.VWStepProcessorObject
        |
        +--filenet.vw.api.VWStepProcessorInfo
All Implemented Interfaces:
IVWtoXML, java.io.Serializable

public final class VWStepProcessorInfo
extends filenet.vw.api.VWStepProcessorObject
implements IVWtoXML

Use this class to access the identity, associated library or Object Store, type, and version of a document used in the workflow process.

Since:
VWWS3.10
See Also:
Serialized Form

Field Summary
static int APP_TYPE_JAVA
          Integer value of 64. This value indicates that the application type is JAVA code.
static int APP_TYPE_URL
          Integer value of 32. This value indicates that the application type is a URL.
static int PROCESSOR_DEFAULT
          Integer value of 3. This value specifies the default launch and the default step processor.
static int PROCESSOR_LAUNCH
          Integer value of 4. This value specifies the non-default launch step processor.
static int PROCESSOR_LAUNCH_DEFAULT
          Integer value of 1. This value specifies the default launch step processor.
static int PROCESSOR_STEP
          Integer value of 8. This value specifies the non-default step processor.
static int PROCESSOR_STEP_DEFAULT
          Integer value of 2. This value specifies the default step processor.
 
Constructor Summary
VWStepProcessorInfo()
          Creates a VWStepProcessorInfo object with empty initial values.
 
Method Summary
 java.lang.String getApplicationName()
          Gets the application name.
 int getAppType()
          Gets the application type, either URL or Java, associated with this step processor.
 int getHeight()
          Gets the height, in pixels, specified for the step processor.
 int getId()
          Gets the ID associated with this step processor information.
 java.lang.String getLocation()
          Deprecated. use getLocation(int nWebApp) instead
 java.lang.String getLocation(int nWebApp)
          Gets the location associated with this step processor information object for the given web application.
 java.util.Hashtable getLocations()
          Gets the locations associated with this step processor information object.
 java.lang.String getName()
          Gets the name associated with this step processor information object.
 int getProcessorType()
          Gets the processorType.
 int getWidth()
          Gets the width, in pixels, specified for the step processor.
 boolean hasChanged()
          Returns whether or not this step processor info definition has changed.
 boolean isDefaultType()
          Determines whether or not the step processor is a default step or default launch processor.
 void setHasChanged(boolean theNewValue)
          This will specifically set the value of hasChanged.
 java.lang.String toString()
          Return a string representation of this VWStepProcessorObject, the value [Id][Pretty Name][URL][height][width]
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string that represents this VWStepProcessorInfo object to the buffer specified by the input parameter.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PROCESSOR_LAUNCH

public static final int PROCESSOR_LAUNCH
Integer value of 4. This value specifies the non-default launch step processor.

PROCESSOR_STEP

public static final int PROCESSOR_STEP
Integer value of 8. This value specifies the non-default step processor.

PROCESSOR_LAUNCH_DEFAULT

public static final int PROCESSOR_LAUNCH_DEFAULT
Integer value of 1. This value specifies the default launch step processor.

PROCESSOR_STEP_DEFAULT

public static final int PROCESSOR_STEP_DEFAULT
Integer value of 2. This value specifies the default step processor.

PROCESSOR_DEFAULT

public static final int PROCESSOR_DEFAULT
Integer value of 3. This value specifies the default launch and the default step processor.

APP_TYPE_URL

public static final int APP_TYPE_URL
Integer value of 32. This value indicates that the application type is a URL.

APP_TYPE_JAVA

public static final int APP_TYPE_JAVA
Integer value of 64. This value indicates that the application type is JAVA code.
Constructor Detail

VWStepProcessorInfo

public VWStepProcessorInfo()
Creates a VWStepProcessorInfo object with empty initial values.
Method Detail

getId

public int getId()
Gets the ID associated with this step processor information.
Overrides:
getId in class filenet.vw.api.VWStepProcessorObject
Returns:
An integer value that represents the unique Id for the step processor.

getName

public java.lang.String getName()
Gets the name associated with this step processor information object.
Overrides:
getName in class filenet.vw.api.VWStepProcessorObject
Returns:
The name of the step processor.

getLocation

public java.lang.String getLocation()
Deprecated. use getLocation(int nWebApp) instead

Gets the location associated with this step processor information object. The location can be a URL of an Active Server Page page.
Overrides:
getLocation in class filenet.vw.api.VWStepProcessorObject
Returns:
A string containg the location of the step processor.

getLocation

public java.lang.String getLocation(int nWebApp)
Gets the location associated with this step processor information object for the given web application. The location can be a URL of an Active Server Page page.
Parameters:
nWebApp - the id of the desired web application
Returns:
A string containg the location of the step processor.

getLocations

public java.util.Hashtable getLocations()
Gets the locations associated with this step processor information object. The location can be a URL of an Active Server Page page.
Overrides:
getLocations in class filenet.vw.api.VWStepProcessorObject
Returns:
A hashtable containg the locations of the step processor by web application. Keys are web applications see VWSession.java

getProcessorType

public int getProcessorType()
Gets the processorType.
Overrides:
getProcessorType in class filenet.vw.api.VWStepProcessorObject
Returns:
An integer value indicating the processor type. The method can return the following integer values:

  • 1: PROCESSOR_LAUNCH_DEFAULT
  • 2: PROCESSOR_STEP_DEFAULT
  • 3: PROCESSOR_DEFAULT
  • 4: PROCESSOR_LAUNCH
  • 8: PROCESSOR_STEP


getAppType

public int getAppType()
Gets the application type, either URL or Java, associated with this step processor.
Overrides:
getAppType in class filenet.vw.api.VWStepProcessorObject
Returns:
An integer value that indication the type of the step processor. The method can return the following integer values:

  • 32: Url (APP_TYPE_URL)
  • 64: Java (APP_TYPE_JAVA)


isDefaultType

public boolean isDefaultType()
Determines whether or not the step processor is a default step or default launch processor.
Overrides:
isDefaultType in class filenet.vw.api.VWStepProcessorObject
Returns:
A Boolean value. The method returns true if step processor is a default type; otherwise, the method returns false.

getHeight

public int getHeight()
Gets the height, in pixels, specified for the step processor.
Overrides:
getHeight in class filenet.vw.api.VWStepProcessorObject
Returns:
An integer value that indicates the height of the step processor, in pixels.

getWidth

public int getWidth()
Gets the width, in pixels, specified for the step processor.
Overrides:
getWidth in class filenet.vw.api.VWStepProcessorObject
Returns:
An integer value that indicates the width of the step processor, in pixels.

getApplicationName

public java.lang.String getApplicationName()
Gets the application name.
Overrides:
getApplicationName in class filenet.vw.api.VWStepProcessorObject
Returns:
The application name of the step processor.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string that represents this VWStepProcessorInfo object to the buffer specified by the input parameter.
Specified by:
toXML in interface IVWtoXML
Parameters:
theBuffer - A string buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

setHasChanged

public void setHasChanged(boolean theNewValue)
This will specifically set the value of hasChanged. This is for INTERNAL PURPOSES ONLY. It is used after doing a commit to reset the hasChanged value back to 'false'.
Parameters:
theNewValue - 'true' to say it has changed, 'false' otherwise

hasChanged

public boolean hasChanged()
Returns whether or not this step processor info definition has changed.
Returns:
'true' if this object has changed, 'false' otherwise

toString

public java.lang.String toString()
Return a string representation of this VWStepProcessorObject, the value [Id][Pretty Name][URL][height][width]
Overrides:
toString in class java.lang.Object

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.