com.ibm.tws.objects.model
Class PromptKey

java.lang.Object
  extended bycom.ibm.tws.objects.model.PromptKey
All Implemented Interfaces:
java.io.Serializable, TWSKey

public class PromptKey
extends java.lang.Object
implements TWSKey

This object represents a prompt external key, including fields used to identify a prompt in TWS external interfaces.

See Also:
Prompt, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
PromptKey()
          Creates an empty PromptKey.
PromptKey(java.lang.String promptName)
          Creates a PromptKey with the specified name.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this PromptKey object are equal to those of the given one.
 java.lang.String getName()
          Returns the prompt name.
 int hashCode()
          Returns a hash code for this PromptKey object.
static PromptKey parseKey(java.lang.String key)
          Parses data from the specified string and creates a new PromptKey.
 void setName(java.lang.String value)
          Sets the prompt name.
 java.lang.String toString()
          Returns a string representation of this PromptKey object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

PromptKey

public PromptKey()
Creates an empty PromptKey.


PromptKey

public PromptKey(java.lang.String promptName)
Creates a PromptKey with the specified name.

Parameters:
promptName - The prompt name.
Method Detail

parseKey

public static PromptKey parseKey(java.lang.String key)
Parses data from the specified string and creates a new PromptKey.

Parameters:
key - The string containing key data.
Returns:
A new PromptKey, or null if the string does not contain a valid key.

getName

public java.lang.String getName()
Returns the prompt name.

Specified by:
getName in interface TWSKey
Returns:
The prompt name.

setName

public void setName(java.lang.String value)
Sets the prompt name.

Parameters:
value - The prompt name.

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this PromptKey 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 PromptKey object.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all PromptKey fields.


Copyright © 2005 IBM All Rights Reserved.