com.ibm.tws.objects.model
Class PeriodKey

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

public class PeriodKey
extends java.lang.Object
implements TWSKey

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

See Also:
Period, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
PeriodKey()
          Creates an empty PeriodKey.
PeriodKey(java.lang.String periodName)
          Creates a PeriodKey with the specified name.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this PeriodKey object are equal to those of the given one.
 java.lang.String getName()
          Returns the period name.
 int hashCode()
          Returns a hash code for this PeriodKey object.
static PeriodKey parseKey(java.lang.String key)
          Parses data from the specified string and creates a new PeriodKey.
 void setName(java.lang.String value)
          Sets the period name.
 java.lang.String toString()
          Returns a string representation of this PeriodKey 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

PeriodKey

public PeriodKey()
Creates an empty PeriodKey.


PeriodKey

public PeriodKey(java.lang.String periodName)
Creates a PeriodKey with the specified name.

Parameters:
periodName - The period name.
Method Detail

parseKey

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

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

getName

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

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

setName

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

Parameters:
value - The period name.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all PeriodKey fields.


Copyright © 2005 IBM All Rights Reserved.