PersistentStorageClient
Class ParameterData

java.lang.Object
  |
  +--PersistentStorageClient.ParameterData

All Implemented Interfaces:

InfrastructureBuilder.UserDefinedFunctions.ParameterDataPacket, BaseClasses.Persistent, java.io.Serializable

public class ParameterData

extends java.lang.Object

implements java.io.Serializable, InfrastructureBuilder.UserDefinedFunctions.ParameterDataPacket, BaseClasses.Persistent

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Constructor Summary

ParameterData()

ParameterData(java.lang.String name, int dataType, int displayedDataType, int ioFlag, boolean runTime, boolean isSwitchDisplayed)
Creates new ParameterData instance.

Method Summary

int	getDataType() Returns parameter data type
int	getDisplayedDataType() Returns parameter data type shown in the Inspector
int	getIOFlag() Returns parameter I/O flag
java.lang.String	getName() Returns parameter name
java.util.Vector	getStringTable() Returns Vector of Strings shown in a pop-up list
boolean	isRunTime() Returns parameter run-time flag
boolean	isSwitchDisplayed() Returns parameter run-time switch flag
void	setDataType(int dataType) Sets the data type of the parameter
void	setDisplayedDataType(int displayedDataType) Sets the data type of the parameter shown in the Inspector
void	setIOFlag(int ioFlag) Sets the Input/Output flag.
void	setName(java.lang.String name) Sets the name of the parameter
void	setRunTime(boolean runTime) Sets the run-time flag.
void	setStringTable(java.util.Vector stringTable) Sets the parameter to display a pop-up list of fixed values.
void	setSwitchDisplayed(boolean isSwitchDisplayed) Sets the run-time switch display flag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ParameterData

public ParameterData()

ParameterData

public ParameterData(java.lang.String name,
                     int dataType,
                     int displayedDataType,
                     int ioFlag,
                     boolean runTime,
                     boolean isSwitchDisplayed)

Creates new ParameterData instance. This object describes one Function parameter, and controls appearance of the parameter slot in the Function object placed in a flowchart.

Parameters:

name - name of the Function

dataType - type of data accepted by the parameter. The following data types are valid:

TEXT	free-formatted text string
DATE	text string in YYYYMMDD format
TIME	text string in HHMMSS format
INTEGER	integer number
FLOAT	double number
MONEY	money value (can be double number)
LOGICAL	0 (false) or 1 (true)

displayedDataType - type of data shown in the Function Inspector (see dataTypes for the list of valid types)

ioFlag - controls input-only or input/output status. The following flags are valid:

INPUT	Parameter does not change its value
OUTPUT	Function changes the parameter's value in the course of execution

runTime - controls initial editable status of the parameter field

isSwitchDisplayed - controls display of the run-time switch

Method Detail

setName

public void setName(java.lang.String name)

Sets the name of the parameter

Parameters:

name - new parameter name

getName

public java.lang.String getName()

Returns parameter name

Specified by:

getName in interface InfrastructureBuilder.UserDefinedFunctions.ParameterDataPacket

Returns:

parameter name

setDataType

public void setDataType(int dataType)

Sets the data type of the parameter

Parameters:

dataType - new data type

getDataType

public int getDataType()

Returns parameter data type

Returns:

parameter data type

setDisplayedDataType

public void setDisplayedDataType(int displayedDataType)

Sets the data type of the parameter shown in the Inspector

getDisplayedDataType

public int getDisplayedDataType()

Returns parameter data type shown in the Inspector

Returns:

parameter display data type

setIOFlag

public void setIOFlag(int ioFlag)

Sets the Input/Output flag.

Parameters:

ioFlag - new I/O flag. The following flags are valid:

INPUT	Parameter does not change its value
OUTPUT	Function changes the parameter's value in the course of execution

getIOFlag

public int getIOFlag()

Returns parameter I/O flag

Returns:

parameter I/O flag

setRunTime

public void setRunTime(boolean runTime)

Sets the run-time flag. If true, the parameter field of the newly dragged-in Function is made non-editable, ready for accepting a variable from the flowchart. If false, the parameter field is editable, ready for typing in a fixed value. The run-time status can be changed using the run-time switch if one is displayed.

isRunTime

public boolean isRunTime()

Returns parameter run-time flag

Returns:

parameter run-time flag

setSwitchDisplayed

public void setSwitchDisplayed(boolean isSwitchDisplayed)

Sets the run-time switch display flag. If true, the run-time switch is shown next to the parameter field.

Parameters:

isSwitchDisplayed - new run-time switch flag

isSwitchDisplayed

public boolean isSwitchDisplayed()

Returns parameter run-time switch flag

Returns:

parameter run-time switch flag

setStringTable

public void setStringTable(java.util.Vector stringTable)

Sets the parameter to display a pop-up list of fixed values.

Parameters:

stringTable - Vector of Strings

getStringTable

public java.util.Vector getStringTable()

Returns Vector of Strings shown in a pop-up list

Returns:

Vector of Strings shown in a pop-up list

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object