Process API

filenet.vw.api
Class VWStepProcessorInfoDefinition

java.lang.Object
  extended by filenet.vw.api.VWStepProcessorInfoDefinition
All Implemented Interfaces:
IVWtoXML, java.io.Serializable, java.lang.Cloneable

public final class VWStepProcessorInfoDefinition
extends java.lang.Object
implements java.lang.Cloneable, IVWtoXML, java.io.Serializable

Use this class' methods to administer Step Processor information. Create this object with VWSystemConfiguration.createStepProcessorInfoDefinition().

Since:
eProcess 4.0
See Also:
VWSystemConfiguration, Serialized Form

Field Summary
static int APP_TYPE_JAVA
          Value of 64. The application type is JAVA code Return value for getAppType method.
static int APP_TYPE_URL
          Value of 32. The application type is a URL Return value for getAppType method.
static int PROCESSOR_DEFAULT
          Value of 3. This value indicates default launch and step processors. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...)
static int PROCESSOR_LAUNCH
          Value of 4. This value indicates that the step is the non-default launch step processor.
static int PROCESSOR_LAUNCH_DEFAULT
          Value of 1. This value indicates that the step is the default launch step processor. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...)
static int PROCESSOR_STEP
          Value of 8. This value indicates a non-default step processor. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...)
static int PROCESSOR_STEP_DEFAULT
          Value of 2. This value indicates a default step processor. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...)
 
Constructor Summary
VWStepProcessorInfoDefinition()
          Creates a minimal VWStepProcessorInfoDefinition object.
VWStepProcessorInfoDefinition(int theId, int theProcessorType, java.lang.String theName, int theAppType, java.util.Hashtable theLocations, int theWidth, int theHeight, java.lang.String theApp)
          Creates a VWStepProcessorInfoDefinition object using input arguments, including a hashtable of the locations associated with this step processor, for each web application.
VWStepProcessorInfoDefinition(int theId, int theProcessorType, java.lang.String theName, int theAppType, java.lang.String theLocation, int theWidth, int theHeight, java.lang.String theApp)
          Deprecated. Replaced by VWStepProcessorInfoDefinition(int, int, String, int, Hashtable, int, int, String), which inputs a hashtable of the locations associated with this step processor, for each web application.
VWStepProcessorInfoDefinition(VWStepProcessorInfo stepProcessorInfo)
          Creates a VWStepProcessorInfoDefinition object using the specified step processor info object.
 
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 getApplicationName()
          Gets the application name.
 int getAppType()
          Gets the application type, either URL or Java, associated with this step processor.
 void getCopy(VWStepProcessorInfoDefinition aSPID)
          Copies and cleans a VWStepProcessorInfoDefinition object that may have a "dirty bit-set".
 int getHeight()
          Gets the height of the step processor, specified in pixels.
 int getId()
          Gets the ID associated with this step processor's information.
 java.lang.String getLocation()
          Deprecated. Replaced by getLocation(int).
 java.lang.String getLocation(int nWebApp)
          Gets the URL location associated with this step processor information object, for the given web application.
 java.util.Hashtable getLocations()
          Gets the URL locations associated with this step processor, for each web application.
 java.lang.String getName()
          Gets the name associated with this step processor's information object.
 int getProcessorType()
          Gets the processor type.
 int getWidth()
          Gets the width of the step processor, specified in pixels.
 boolean hasChanged()
          Determines whether or not this step processor definition has changed.
 boolean isDefaultType()
          Determine whether or not the step processor is a default step or default launch processor.
 void setApplicationName(java.lang.String theApplicationName)
          Sets the application name.
 void setAppType(int theAppType)
          Sets the application type associated with this step processor's information.
 void setDefaultType(int theDefaultType)
          Sets the step processor default type.
 void setHasChanged(boolean theNewValue)
          Sets the hasChanged property value.
 void setHeight(int theHeight)
          Sets the height of the step processor.
 void setLocation(java.lang.String theLocation)
          Deprecated. Replaced by setLocations(Hashtable).
 void setLocations(java.util.Hashtable theLocations)
          Sets the URL locations associated with this step processor, for each web application.
 void setName(java.lang.String theName)
          Sets the name associated with this step processor's information object.
 void setProcessorType(int theProcessorType)
          Sets the processorType associated with this step processor's information.
 void setWidth(int theWidth)
          Sets the width associated with this step processor's information.
 java.lang.String toString()
          Gets a string representation of the step processor object.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string representing this instance to the buffer specified.
 
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 indicates that the step is the non-default launch step processor.

See Also:
getProcessorType(), Constant Field Values

PROCESSOR_STEP

public static final int PROCESSOR_STEP
Value of 8. This value indicates a non-default step processor. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...) methods refer to these static variables.

See Also:
Constant Field Values

PROCESSOR_LAUNCH_DEFAULT

public static final int PROCESSOR_LAUNCH_DEFAULT
Value of 1. This value indicates that the step is the default launch step processor. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...) methods refer to these static variables.

See Also:
Constant Field Values

PROCESSOR_STEP_DEFAULT

public static final int PROCESSOR_STEP_DEFAULT
Value of 2. This value indicates a default step processor. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...) methods refer to these static variables.

See Also:
Constant Field Values

PROCESSOR_DEFAULT

public static final int PROCESSOR_DEFAULT
Value of 3. This value indicates default launch and step processors. The VWStepProcessorInfoDefinition.getProcessorType(...) and the VWStepProcessorInfoDefinition.setProcessorType(...) methods refer to these static variables.

See Also:
Constant Field Values

APP_TYPE_URL

public static final int APP_TYPE_URL
Value of 32. The application type is a URL Return value for getAppType method.

See Also:
Constant Field Values

APP_TYPE_JAVA

public static final int APP_TYPE_JAVA
Value of 64. The application type is JAVA code Return value for getAppType method.

See Also:
Constant Field Values
Constructor Detail

VWStepProcessorInfoDefinition

public VWStepProcessorInfoDefinition()
Creates a minimal VWStepProcessorInfoDefinition object.


VWStepProcessorInfoDefinition

public VWStepProcessorInfoDefinition(int theId,
                                     int theProcessorType,
                                     java.lang.String theName,
                                     int theAppType,
                                     java.lang.String theLocation,
                                     int theWidth,
                                     int theHeight,
                                     java.lang.String theApp)
                              throws VWException
Deprecated. Replaced by VWStepProcessorInfoDefinition(int, int, String, int, Hashtable, int, int, String), which inputs a hashtable of the locations associated with this step processor, for each web application.

Creates a VWStepProcessorInfoDefinition object using input arguments.

Parameters:
theId -
theProcessorType -
theName -
theAppType -
theLocation -
theWidth -
theHeight -
theApp -
Throws:
VWException

VWStepProcessorInfoDefinition

public VWStepProcessorInfoDefinition(int theId,
                                     int theProcessorType,
                                     java.lang.String theName,
                                     int theAppType,
                                     java.util.Hashtable theLocations,
                                     int theWidth,
                                     int theHeight,
                                     java.lang.String theApp)
                              throws VWException
Creates a VWStepProcessorInfoDefinition object using input arguments, including a hashtable of the locations associated with this step processor, for each web application.

Parameters:
theId -
theProcessorType -
theName -
theAppType -
theLocations -
theWidth -
theHeight -
theApp -
Throws:
VWException

VWStepProcessorInfoDefinition

public VWStepProcessorInfoDefinition(VWStepProcessorInfo stepProcessorInfo)
                              throws VWException
Creates a VWStepProcessorInfoDefinition object using the specified step processor info object.

Parameters:
stepProcessorInfo -
Throws:
VWException
Since:
P8 4.5.0
Method Detail

_get_FILE_DATE

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

Returns:
the file date

_get_FILE_AUTHOR

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

Returns:
the file author

_get_FILE_REVISION

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

Returns:
the file revision

getCopy

public void getCopy(VWStepProcessorInfoDefinition aSPID)
Copies and cleans a VWStepProcessorInfoDefinition object that may have a "dirty bit-set". .

Parameters:
aSPID -

getId

public int getId()
Gets the ID associated with this step processor's information.

Returns:
An integer value representing the unique ID of the step processor.

getName

public java.lang.String getName()
Gets the name associated with this step processor's information object. If a translation source exists, the authored step processor name is translated.

Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

Returns:
A String containing the translated step processor name of this instance, if a translation source exists; otherwise the authored name is returned.

getLocation

public java.lang.String getLocation()
Deprecated. Replaced by getLocation(int).

Gets the URL location associated with this step processor. The location will depend on the session Web Application ID.

Returns:
The location of the step processor.

getLocation

public java.lang.String getLocation(int nWebApp)
Gets the URL location associated with this step processor information object, for the given web application. The location can be a URL of an Active Server Page.

Parameters:
nWebApp - The id of the desired web application
Returns:
A string containing the URL location of the step processor.

getLocations

public java.util.Hashtable getLocations()
Gets the URL locations associated with this step processor, for each web application.

Returns:
The locations associated with this step processor, for each web application.

getProcessorType

public int getProcessorType()
Gets the processor type.

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.

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()
Determine whether or not the step processor is a default step or default launch processor.

Returns:
A Boolean value: true if the step processor is a default type; false otherwise.

getHeight

public int getHeight()
Gets the height of the step processor, specified in pixels.

Returns:
An integer value that represents the height of the step processor, in pixels.

getWidth

public int getWidth()
Gets the width of the step processor, specified in pixels.

Returns:
An integer value that represents the width of the step processor, in pixels.

getApplicationName

public java.lang.String getApplicationName()
Gets the application name.

Returns:
The application name for this step processor.

setName

public void setName(java.lang.String theName)
             throws VWException
Sets the name associated with this step processor's information object. The name cannot be changed if the step processor has already be transferred.

Parameters:
theName - New name for the step processor, must not be null.
Throws:
VWException - thrown if the name is null or the step processor has already been committed (transferred) to the server.

setLocation

public void setLocation(java.lang.String theLocation)
                 throws VWException
Deprecated. Replaced by setLocations(Hashtable).

Sets the URL location associated with this step processor.

Parameters:
theLocation - The new URL location of the step processor.
Throws:
VWException

setLocations

public void setLocations(java.util.Hashtable theLocations)
                  throws VWException
Sets the URL locations associated with this step processor, for each web application.

Parameters:
theLocations - The new URL locations associated with this step processor.
Throws:
VWException

setProcessorType

public void setProcessorType(int theProcessorType)
                      throws VWException
Sets the processorType associated with this step processor's information.

Parameters:
theProcessorType - A valid processor type, in integer format.
Throws:
VWException - Thrown if an invalid type is specified by the input parameter.

setAppType

public void setAppType(int theAppType)
                throws VWException
Sets the application type associated with this step processor's information.

Parameters:
theAppType - An integer value specifying the application type of the processor. Valid input values are as follows:

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

Throws:
VWException - Thrown if it cannot set the application type associated with this step processor's information.

setDefaultType

public void setDefaultType(int theDefaultType)
                    throws VWException
Sets the step processor default type.

Parameters:
theDefaultType - An integer value specifying the type for the default step processor.

Valid input values are as follows:

  • 1: PROCESSOR_LAUNCH_DEFAULT
  • 2: PROCESSOR_STEP_DEFAULT

Throws:
VWException - Thrown if it cannot set the step processor default type.

setHeight

public void setHeight(int theHeight)
               throws VWException
Sets the height of the step processor.

Parameters:
theHeight - Height of the step processor, in pixels.
Throws:
VWException - Thrown if it cannot set the height of the step processor.

setWidth

public void setWidth(int theWidth)
              throws VWException
Sets the width associated with this step processor's information.

Parameters:
theWidth - Width of the step processor, in pixels.
Throws:
VWException - Thrown if it cannot set the width associated with this step processor's information.

setHasChanged

public void setHasChanged(boolean theNewValue)
Sets the hasChanged property value. This is for INTERNAL PURPOSES ONLY. Call this method after committing a work item to reset the hasChanged value to false.

Parameters:
theNewValue - A Boolean value. Specify true to indicate the item has been updated; otherwise, specify false.

hasChanged

public boolean hasChanged()
Determines whether or not this step processor definition has changed.

Returns:
A Boolean value: true if the VWStepProcessorInfoDefinition object has changed; false, otherwise.

setApplicationName

public void setApplicationName(java.lang.String theApplicationName)
                        throws VWException
Sets the application name.

Parameters:
theApplicationName - The new name for the application.
Throws:
VWException - Thrown if it cannot set the application name.

toString

public java.lang.String toString()
Gets a string representation of the step processor object.

Returns:
A string containing a representation of this VWStepProcessorObject. The string is formatted as follows:

[Id] [URL] [Name] [Location] [Height] [Width] [AppName].


toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Specified by:
toXML in interface IVWtoXML
Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

Process API

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