|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWStepProcessorObject | +--filenet.vw.api.VWStepProcessorInfoDefinition
Use this class' methods to administer
Step Processor information. Create this object with VWSystemConfiguration.createStepProcessorInfoDefinition()
.
VWSystemConfiguration
, Serialized FormField 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(...) methods refer to these static variables. |
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(...) methods refer to these static variables. |
static 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. |
static 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. |
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. |
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. |
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. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int PROCESSOR_LAUNCH
getProcessorType()
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 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
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.
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
Method Detail |
public void getCopy(VWStepProcessorInfoDefinition aSPID)
public int getId()
getId
in class filenet.vw.api.VWStepProcessorObject
public java.lang.String getName()
getName
in class filenet.vw.api.VWStepProcessorObject
public java.lang.String getLocation()
getLocation(int)
.
getLocation
in class filenet.vw.api.VWStepProcessorObject
public java.lang.String getLocation(int nWebApp)
nWebApp
- The id of the desired web applicationpublic java.util.Hashtable getLocations()
getLocations
in class filenet.vw.api.VWStepProcessorObject
public int getProcessorType()
getProcessorType
in class filenet.vw.api.VWStepProcessorObject
public int getAppType()
getAppType
in class filenet.vw.api.VWStepProcessorObject
public boolean isDefaultType()
isDefaultType
in class filenet.vw.api.VWStepProcessorObject
true
if the step
processor is a default type; false
otherwise.public int getHeight()
getHeight
in class filenet.vw.api.VWStepProcessorObject
public int getWidth()
getWidth
in class filenet.vw.api.VWStepProcessorObject
public java.lang.String getApplicationName()
getApplicationName
in class filenet.vw.api.VWStepProcessorObject
public void setName(java.lang.String theName) throws VWException
public void setLocation(java.lang.String theLocation) throws VWException
setLocations(Hashtable)
.
theLocation
- The new URL location of the
step processor.VWException
- public void setLocations(java.util.Hashtable theLocations) throws VWException
theLocations
- The new URL locations associated with
this step processor.
VWException
- public void setProcessorType(int theProcessorType) throws VWException
theProcessorType
- A valid processor type, in integer format.VWException
- Thrown if an invalid type is specified by
the input parameter.public void setAppType(int theAppType) throws VWException
theAppType
- An integer value specifying the application
type of the processor. Valid input values are as follows:
VWException
- Thrown if it cannot
set the application type associated with this step processor's
information.public void setDefaultType(int theDefaultType) throws VWException
theDefaultType
- An integer value specifying the type
for the default step processor.
Valid input values are as follows:
VWException
- Thrown if it cannot
set the step processor default type.public void setHeight(int theHeight) throws VWException
theHeight
- Height of the step processor, in pixels.VWException
- Thrown if it cannot
set the height of the step processor.public void setWidth(int theWidth) throws VWException
theWidth
- Width of the step processor, in pixels.VWException
- Thrown if it cannot
set the width associated with this step processor's information.public void setHasChanged(boolean theNewValue)
setHasChanged
in class filenet.vw.api.VWStepProcessorObject
theNewValue
- A Boolean value. Specify true
to indicate
the item has been updated; otherwise, specify false
.public boolean hasChanged()
hasChanged
in class filenet.vw.api.VWStepProcessorObject
true
if the
VWStepProcessorInfoDefinition object has
changed; false
, otherwise.public void setApplicationName(java.lang.String theApplicationName) throws VWException
theApplicationName
- The new name
for the application.VWException
- Thrown if it cannot
set the application name.public java.lang.String toString()
toString
in class filenet.vw.api.VWStepProcessorObject
[Id] [URL] [Name] [Location] [Height] [Width] [AppName].
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |