|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.model.Prompt
This simple object, which has no header, models all available types of prompts (predefined, ad-hoc or recovery), and wraps a PromptKey, including only the prompt name.
The following syntax validation constraints must be met on Prompt objects:
name | Required for predefined prompts, null for recovery and ad-hoc ones |
Alphanumeric characters | |
Starting with alphabetic character | |
'-' and '_' characters allowed | |
Blank spaces not allowed | |
Not longer than 8 characters | |
text | Not longer than 200 characters |
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright. |
Constructor Summary | |
---|---|
Prompt()
Creates an empty Prompt. |
|
Prompt(Identifier promptId)
Creates a Prompt with the specified identifier. |
|
Prompt(Identifier promptId,
PromptKey promptKey)
Creates a Prompt with the specified identifier and key. |
|
Prompt(PromptKey promptKey)
Creates a Prompt with the specified key. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
Returns true if all fields of this Prompt object are equal to those of the given one. |
Identifier |
getId()
Returns the prompt identifier. |
PromptKey |
getKey()
Returns the PromptKey wrapped by this Prompt object. |
LockData |
getLockData()
Returns the prompt lock data. |
ModifyData |
getModifyData()
Returns the prompt modification data. |
java.lang.String |
getName()
Returns the prompt name. |
TWSHeader |
getObjectHeader()
Returns this object, which also acts as a TWS header. |
TWSKey |
getObjectKey()
Returns the prompt key as a TWS key. |
java.lang.String |
getText()
Returns the prompt text. |
int |
hashCode()
Returns a hash code for this Prompt object. |
void |
setId(Identifier identifier)
Sets the prompt identifier. |
void |
setKey(PromptKey promptKey)
Sets the PromptKey to be wrapped by this Prompt object. |
void |
setLockData(LockData data)
Sets the prompt lock data. |
void |
setModifyData(ModifyData data)
Sets the prompt modification data. |
void |
setName(java.lang.String value)
Sets the prompt name. |
void |
setText(java.lang.String value)
Sets the prompt text. |
java.lang.String |
toString()
Returns a string representation of this Prompt 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 Prompt()
public Prompt(Identifier promptId)
promptId
- The prompt identifier.public Prompt(PromptKey promptKey)
promptKey
- The prompt key.public Prompt(Identifier promptId, PromptKey promptKey)
promptId
- The prompt identifier.promptKey
- The prompt 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 PromptKey getKey()
public java.lang.String getName()
getName
in interface TWSObject
public java.lang.String getText()
public ModifyData getModifyData()
getModifyData
in interface TWSObject
public LockData getLockData()
getLockData
in interface TWSObject
public void setId(Identifier identifier)
identifier
- The prompt identifier.public void setKey(PromptKey promptKey)
promptKey
- The PromptKey to be wrapped by this Prompt object.public void setName(java.lang.String value)
value
- The prompt name.public void setText(java.lang.String value)
value
- The prompt text.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 |