Process UI Toolkit API

filenet.vw.toolkit.runtime.step
Class VWPanelComponentInfo

java.lang.Object
  extended by filenet.vw.toolkit.runtime.step.VWPanelComponentInfo
All Implemented Interfaces:
IVWPanelComponent

public class VWPanelComponentInfo
extends java.lang.Object
implements IVWPanelComponent

This class provides the means to retrieve information about the specified parameter from the step element and saves the changes to the step element.

Note: Like the other components that can be contained in the VWPanel container, this class implements the IVWPanelComponent interface.

Since:
eProcess 4.0

Field Summary
 
Fields inherited from interface filenet.vw.toolkit.runtime.step.IVWPanelComponent
PARAM_CANCEL, PARAM_COMMENT, PARAM_COMPLETE, PARAM_DATE_RECEIVED, PARAM_DEADLINE, PARAM_EXCEPTION_DESCRIPTION, PARAM_EXCEPTION_MAP, PARAM_HELP, PARAM_HISTORY, PARAM_LAUNCH_DATE, PARAM_OPERATION_NAME, PARAM_ORIGINATOR, PARAM_PARTICIPANT, PARAM_QUEUE_NAME, PARAM_REASSIGN, PARAM_RESPONSES, PARAM_RETURN, PARAM_ROSTER_NAME, PARAM_SAVE, PARAM_SELECTED_RESPONSE, PARAM_STATUS, PARAM_STEP_DESCRIPTION, PARAM_STEP_NAME, PARAM_SUBJECT, PARAM_TAG, PARAM_WORK_CLASS_NAME, PARAM_WORK_OBJECT_NAME, PARAM_WORK_OBJECT_NUMBER, PARAM_WORKFLOW_NAME, PARAM_WORKFLOW_NUMBER
 
Constructor Summary
VWPanelComponentInfo()
           
 
Method Summary
 boolean doSave()
          Completes the workflow step when the step is saved.
 java.lang.String getDescription()
          Retrieves a string representation of the specified parameter's description.
 java.lang.String getParameterName()
          Retrieves the string value of the parameter name.
 int getType()
          Returns the data type of the parameter.
 java.lang.Object getValue()
          Retrieves the value from the specified parameter.
 boolean isProtected()
          Determines if the parameter value can be altered.
 void setParameterName(java.lang.String name)
          Sets the string value of the parameter name.
 void setStepElement(filenet.vw.api.VWStepElement stepElement)
          Determines if the VWStepElement object is valid and sets the object to accept changes.
 void setValue(java.lang.Object value)
          Sets the value for the specified parameter.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VWPanelComponentInfo

public VWPanelComponentInfo()
Method Detail

getDescription

public java.lang.String getDescription()
Retrieves a string representation of the specified parameter's description.

Returns:
A string containing the description.
Since:
eProcess 4.0

getType

public int getType()
Returns the data type of the parameter.

Returns:
An integer value corresponding to the VWParameter field type. For available field type integers that can be returned, see VWFieldType.
Since:
eProcess 4.0

getValue

public java.lang.Object getValue()
Retrieves the value from the specified parameter.

Returns:
An object containing the value for the specified parameter.
Since:
eProcess 4.0

setValue

public void setValue(java.lang.Object value)
Sets the value for the specified parameter.

Parameters:
value - An object containing the value for the specified parameter.
Since:
eProcess 4.0

isProtected

public boolean isProtected()
Determines if the parameter value can be altered.

Returns:
A boolean value; the method returns TRUE if the parameter value is Read-only; otherwise, the method returns FALSE.
Since:
eProcess 4.0

getParameterName

public java.lang.String getParameterName()
Retrieves the string value of the parameter name.

Specified by:
getParameterName in interface IVWPanelComponent
Returns:
A string containing the parameter name.
Since:
eProcess 4.0

setParameterName

public void setParameterName(java.lang.String name)
Sets the string value of the parameter name.

Specified by:
setParameterName in interface IVWPanelComponent
Parameters:
name - A string containing the new name parameter name.
Since:
eProcess 4.0

doSave

public boolean doSave()
Completes the workflow step when the step is saved.

Specified by:
doSave in interface IVWPanelComponent
Returns:
A boolean value; the method returns TRUE if the save operation succeeded; otherwise, the method returns FALSE.
Since:
eProcess 4.0

setStepElement

public void setStepElement(filenet.vw.api.VWStepElement stepElement)
Determines if the VWStepElement object is valid and sets the object to accept changes.

Specified by:
setStepElement in interface IVWPanelComponent
Parameters:
stepElement - A valid VWStepElement object.
Since:
eProcess 4.0
See Also:
VWStepElement

Process UI Toolkit API

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