|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWStepProcessorInfo
public final class VWStepProcessorInfo
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).
VWWorkObject
,
VWQueueElement
,
Serialized FormField 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 | |
---|---|
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, 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 instance. |
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 instance. |
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] |
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 |
---|
public static final int PROCESSOR_LAUNCH
public static final int PROCESSOR_STEP
public static final int PROCESSOR_LAUNCH_DEFAULT
public static final int PROCESSOR_STEP_DEFAULT
public static final int PROCESSOR_DEFAULT
public static final int APP_TYPE_URL
public static final int APP_TYPE_JAVA
Constructor Detail |
---|
public VWStepProcessorInfo()
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public int getId()
public java.lang.String getName()
public java.lang.String getLocation()
getLocation(int)
.
public java.lang.String getLocation(int nWebApp)
nWebApp
- The web
application type identifier value of the desired web application.
public java.util.Hashtable getLocations()
public int getProcessorType()
public int getAppType()
public boolean isDefaultType()
true
if
the step processor is a default type; otherwise, the method
returns false
.public int getHeight()
public int getWidth()
public java.lang.String getApplicationName()
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
toXML
in interface IVWtoXML
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public void setHasChanged(boolean theNewValue)
theNewValue
- 'true' to say it has changed, 'false' otherwisepublic boolean hasChanged()
public java.lang.String toString()
toString
in class java.lang.Object
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |