com.ibm.tws.objects.plan
Class SymphonyInPlanKey

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

public class SymphonyInPlanKey
extends java.lang.Object
implements TWSKey

This object represents a Symphony file external key, including fields used to identify a Symphony in TWS external interfaces. Since a file is identified substantially by its name and its type, this class includes a name attribute and a type attribute. In the name attribute the Symphony file name but the first char is stored. In the Symphont type the type of the Symphony (identified by that first char) one of the value present in the SymphonyType class is stored

See Also:
SymphonyType, SymphonyInPlan, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
SymphonyInPlanKey()
          Empty Constructor
SymphonyInPlanKey(java.lang.String name, SymphonyType type)
          Constructor for this class.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this SymphonyInPlan object are equal to those of the given one.
 java.lang.String getName()
          Returns the Symphony name
 SymphonyType getType()
          Returns the Symphony Type.
 int hashCode()
          Returns a hash code for this Symphony object.
 void setName(java.lang.String string)
          Set the symphony name
 void setType(SymphonyType type)
          Sets the Symphony Type
 java.lang.String toString()
          Returns a string representation of this SymphonyInPlan 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

SymphonyInPlanKey

public SymphonyInPlanKey()
Empty Constructor


SymphonyInPlanKey

public SymphonyInPlanKey(java.lang.String name,
                         SymphonyType type)
Constructor for this class.

Parameters:
name - the symphony name.
type - the symphony type.
Method Detail

getName

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

Specified by:
getName in interface TWSKey
Returns:
the Symphony name
See Also:
TWSKey.getName()

setName

public void setName(java.lang.String string)
Set the symphony name

Parameters:
string - the symphony name

equals

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

Parameters:
object - The object to be compared
Returns:
boolean True if objects are euqla

hashCode

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

Returns:
int the object's hash code

toString

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

Returns:
String This object's String representation

getType

public SymphonyType getType()
Returns the Symphony Type.

Returns:
the Symphony Type

setType

public void setType(SymphonyType type)
Sets the Symphony Type

Parameters:
type - the Symphony Type


Copyright © 2005 IBM All Rights Reserved.