com.ibm.tws.objects.plan.types
Class JCLPromptableVariable

java.lang.Object
  extended bycom.ibm.tws.objects.plan.types.JCLPromptableVariable
All Implemented Interfaces:
java.io.Serializable

public class JCLPromptableVariable
extends java.lang.Object
implements java.io.Serializable

This class includes the information required to describe the JCLPromptableVariable. It is only used in zOS environment.

The following syntax validation constraints must be met on JCLPromptableVariable objects in zOS environment:

name Always required
Alphanumeric characters
Starting with alphabetic character
Blank spaces not allowed
Not longer than 8 characters
value Not longer than 44 characters
status One of the following value defined in this class:
PROMPTABLESTATUS_LEFTTORIGHTSUB (default)
PROMPTABLESTATUS_TABULAR
PROMPTABLESTATUS_COMPOUND

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
static int PROMPTABLESTATUS_COMPOUND
          Status of the variable compound
static int PROMPTABLESTATUS_LEFTTORIGHTSUB
          The default status of the variable (left to right)
static int PROMPTABLESTATUS_TABULAR
          Status of the variable tabular
 
Constructor Summary
JCLPromptableVariable()
          Creates an empty promptable variable.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this object are equal to those of the given one.
 java.lang.String getName()
          Returns the name of the variable
 int getStatus()
          Returns the status of the variable
 java.lang.String getValue()
          Returns the value of the variable
 int hashCode()
          Returns a hash code for this object.
 void setName(java.lang.String name)
          Sets the name of the variable
 void setStatus(int status)
          Sets the status of the variable For internal use only.
 void setValue(java.lang.String value)
          Sets the value of the variable
 java.lang.String toString()
          Returns a string representation of this object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

PROMPTABLESTATUS_LEFTTORIGHTSUB

public static final int PROMPTABLESTATUS_LEFTTORIGHTSUB
The default status of the variable (left to right)

See Also:
Constant Field Values

PROMPTABLESTATUS_TABULAR

public static final int PROMPTABLESTATUS_TABULAR
Status of the variable tabular

See Also:
Constant Field Values

PROMPTABLESTATUS_COMPOUND

public static final int PROMPTABLESTATUS_COMPOUND
Status of the variable compound

See Also:
Constant Field Values

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

JCLPromptableVariable

public JCLPromptableVariable()
Creates an empty promptable variable.

Method Detail

getName

public java.lang.String getName()
Returns the name of the variable

Returns:
Returns the name.

getValue

public java.lang.String getValue()
Returns the value of the variable

Returns:
Returns the value.

getStatus

public int getStatus()
Returns the status of the variable

Returns:
Returns the status.

setName

public void setName(java.lang.String name)
Sets the name of the variable

Parameters:
name - The name to set.

setValue

public void setValue(java.lang.String value)
Sets the value of the variable

Parameters:
value - The value to set.

setStatus

public void setStatus(int status)
Sets the status of the variable For internal use only.

Parameters:
status - The status to set.

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this object are equal to those of the given one.

Parameters:
object - The object to be compared with this one.
Returns:
True if this object equals to the given one.

hashCode

public int hashCode()
Returns a hash code for this object.

Returns:
The object's hash code.

toString

public java.lang.String toString()
Returns a string representation of this object.

Returns:
A text string including all fields.


Copyright © 2005 IBM All Rights Reserved.