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 properties of the step processor object that are useful for launching a step, such as its dimensions, processor name and type, and Web application location.

A Step Processor is an application that provides and processes the information and resources that a user (a workflow participant) needs in order to complete a step in a workflow. When a user opens a work item, the Step Processor typically displays the instructions, the attachments retrieved from an Object or File Store, current field values, response options, and other resources necessary to allow the user to process and complete the step.

The current step processor information object for a work object can be retrieved by calling the fetchStepProcessorInfo() method, which is a member of the work object (class VWWorkObject) or its associated queue element (class VWQueueElement).

Since:
VWWS3.10
See Also:
VWWorkObject, VWQueueElement, Serialized Form

Field Summary
static int APP_TYPE_JAVA
          Value of 64. This value indicates that the application type is JAVA code.
static int APP_TYPE_URL
          Value of 32. This value indicates that the application type is a URL.
static int PROCESSOR_DEFAULT
          Value of 3. This value specifies the default launch and the default step processor.
static int PROCESSOR_LAUNCH
          Value of 4. This value specifies the non-default launch step processor.
static int PROCESSOR_LAUNCH_DEFAULT
          Value of 1. This value specifies the default launch step processor.
static int PROCESSOR_STEP
          Value of 8. This value specifies the non-default step processor.
static int PROCESSOR_STEP_DEFAULT
          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, which is the Java application class that can be invoked, or the empty String if the application type is HTML.
 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. Replaced by getLocation(int).
 java.lang.String getLocation(int nWebApp)
          Gets the location associated with this step processor information object, given the web application type identifier.
 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 processor type, step or launch, default or not.
 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()
          Indicates whether or not the step processor is a default step or 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 a description of this object's properties, formatted as an XML string, to the specified input buffer.
 
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
Value of 4. This value specifies the non-default launch step processor.

PROCESSOR_STEP

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

PROCESSOR_LAUNCH_DEFAULT

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

PROCESSOR_STEP_DEFAULT

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

PROCESSOR_DEFAULT

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

APP_TYPE_URL

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

APP_TYPE_JAVA

public static final int APP_TYPE_JAVA
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. Replaced by getLocation(int).

Gets the location associated with this step processor information object. A location is a relative path to a web page, which can be an ASP, ASPX, or JSP file, depending on the web application service model of your system.
Overrides:
getLocation in class filenet.vw.api.VWStepProcessorObject
Returns:
A String containing the location of the step processor.

getLocation

public java.lang.String getLocation(int nWebApp)
Gets the location associated with this step processor information object, given the web application type identifier. A location is a relative path to a web page, which can be an ASP, ASPX, or JSP file, depending on the web application service model of your system.
Parameters:
nWebApp - The web application type identifier value of the desired web application.
Returns:
A String containing the location of the step processor.

getLocations

public java.util.Hashtable getLocations()
Gets the locations associated with this step processor information object. A location is a relative path to a web page, which can be an ASP, ASPX, or JSP file, depending on the web application service model of your system.
Overrides:
getLocations in class filenet.vw.api.VWStepProcessorObject
Returns:
A hashtable containing the locations of the step processors, whose key values are web application type identifier values.

getProcessorType

public int getProcessorType()
Gets the processor type, step or launch, default or not.
Overrides:
getProcessorType in class filenet.vw.api.VWStepProcessorObject
Returns:
An integer value indicating the processor type. This method returns 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 indicates the type of the step processor. This method can return the following integer values:

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


isDefaultType

public boolean isDefaultType()
Indicates whether or not the step processor is a default step or launch processor.
Overrides:
isDefaultType in class filenet.vw.api.VWStepProcessorObject
Returns:
A boolean value. The method returns true if the 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, which is the Java application class that can be invoked, or the empty String if the application type is HTML.
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 a description of this object's properties, formatted as an XML string, to the specified input buffer.

This description includes Name, Id, Application, Processor Type, Processor Location(s), Application Type,Application Name, IsDefault flag, Width, and Height.

Warning: This general list of properties currently contained in the appended string is subject to change without notice.

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


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.