|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.model.Variable
A Variable object represents a TWS parameter and wraps a VariableKey object. No object is referenced by the Variable class, which only includes the attributes of the corresponding parameter.
The following syntax validation constraints must be met on Variable objects:
name | Always required |
Alphanumeric characters | |
Starting with alphabetic character | |
'-' and '_' characters allowed | |
Blank spaces not allowed | |
Not longer than 8 characters | |
value | Not longer than 72 characters |
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright. |
Constructor Summary | |
---|---|
Variable()
Creates an empty Variable. |
|
Variable(Identifier variableId)
Creates a Variable with the specified identifier. |
|
Variable(Identifier variableId,
VariableKey variableKey)
Creates a Variable with the specified identifier and key. |
|
Variable(VariableKey variableKey)
Creates a Variable with the specified key. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
Returns true if all fields of this Variable object are equal to those of the given one. |
java.lang.String |
getDescription()
Returns the variable description. |
Identifier |
getId()
Returns the variable identifier. |
VariableKey |
getKey()
Returns the VariableKey wrapped by this Variable object. |
LockData |
getLockData()
Returns the variable lock data. |
ModifyData |
getModifyData()
Returns the variable modification data. |
java.lang.String |
getName()
Returns the variable name. |
TWSHeader |
getObjectHeader()
Returns this object, which also acts as a TWS header. |
TWSKey |
getObjectKey()
Returns the variable key as a TWS key. |
java.lang.String |
getValue()
Returns the variable value. |
int |
hashCode()
Returns a hash code for this Variable object. |
void |
setDescription(java.lang.String string)
Sets the variable description. |
void |
setId(Identifier identifier)
Sets the variable identifier. |
void |
setKey(VariableKey variableKey)
Sets the VariableKey to be wrapped by this Variable object. |
void |
setLockData(LockData data)
Sets the variable lock data. |
void |
setModifyData(ModifyData data)
Sets the variable modification data. |
void |
setName(java.lang.String string)
Sets the variable name. |
void |
setValue(java.lang.String string)
Sets the variable value. |
java.lang.String |
toString()
Returns a string representation of this Variable object. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public Variable()
public Variable(Identifier variableId)
variableId
- The variable identifier.public Variable(VariableKey variableKey)
variableKey
- The variable key.public Variable(Identifier variableId, VariableKey variableKey)
variableId
- The variable identifier.variableKey
- The variable key.Method Detail |
public Identifier getId()
getId
in interface TWSObject
public TWSKey getObjectKey()
getObjectKey
in interface TWSObject
public TWSHeader getObjectHeader()
getObjectHeader
in interface TWSObject
public VariableKey getKey()
public java.lang.String getName()
getName
in interface TWSObject
public java.lang.String getValue()
public java.lang.String getDescription()
public ModifyData getModifyData()
getModifyData
in interface TWSObject
public LockData getLockData()
getLockData
in interface TWSObject
public void setId(Identifier identifier)
identifier
- The variable identifier.public void setKey(VariableKey variableKey)
variableKey
- The VariableKey to be wrapped by this Variable object.public void setName(java.lang.String string)
string
- The variable name.public void setValue(java.lang.String string)
string
- The variable value.public void setDescription(java.lang.String string)
string
- The variable description.public void setModifyData(ModifyData data)
data
- A ModifyData object.public void setLockData(LockData data)
data
- A LockData object.public boolean equals(java.lang.Object object)
object
- The object to be compared with this one.
public int hashCode()
public java.lang.String toString()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |