com.ibm.tws.objects.plan
Class FileInPlanKey

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

public class FileInPlanKey
extends java.lang.Object
implements TWSKey

This class represents a file instance key, included in a FileInPlan object. It include a reference to the workstation on which the file is present. This class implements TWSKey.

The following syntax validation constraints must be met on FileInPlanKey objects:

name Name of an existing file in the Symphony.
workstationKey Reference to an existing workstation.

See Also:
FileInPlan, WorkstationInPlanKey, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright
 
Constructor Summary
FileInPlanKey()
          Creates an empty FileInPlanKey.
FileInPlanKey(java.lang.String name, WorkstationInPlanKey key)
          Creates a FileInPlanKey
 
Method Summary
 boolean equals(java.lang.Object object)
          equality method.
 java.lang.String getName()
          Returns the key name.
 WorkstationInPlanKey getWorkstationKey()
          Return the WorkstationInPlanKey on which this FileInPlan object is defined.
 int hashCode()
          Returns a hash code for this FileInPlanKey object.
 void setName(java.lang.String string)
          Set the name of the FileInPlan object.
 void setWorkstationKey(WorkstationInPlanKey key)
          Set the WorkstationInPlanKey on which this FileInPlan object is defined.
 java.lang.String toString()
          Returns a string representation of this FileInPlanKey.
 
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

FileInPlanKey

public FileInPlanKey()
Creates an empty FileInPlanKey.


FileInPlanKey

public FileInPlanKey(java.lang.String name,
                     WorkstationInPlanKey key)
Creates a FileInPlanKey

Parameters:
name - The name of this FileInPlan
key - The WorkstationInPlanKey
Method Detail

getName

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

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

setName

public void setName(java.lang.String string)
Set the name of the FileInPlan object.

Parameters:
string - the new key name

equals

public boolean equals(java.lang.Object object)
equality method.

Parameters:
object - the object to be evaluated.
Returns:
true if the two FileInPlanKey are equals, false otherwise.

hashCode

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all FileInPlanKey fields.

getWorkstationKey

public WorkstationInPlanKey getWorkstationKey()
Return the WorkstationInPlanKey on which this FileInPlan object is defined.

Returns:
the workstation on which this object is defined.

setWorkstationKey

public void setWorkstationKey(WorkstationInPlanKey key)
Set the WorkstationInPlanKey on which this FileInPlan object is defined.

Parameters:
key - the workstation on which this object is defined.


Copyright © 2005 IBM All Rights Reserved.