com.ibm.tws.objects.model
Class FlowTargetHeader

java.lang.Object
  extended bycom.ibm.tws.objects.model.FlowTargetHeader
All Implemented Interfaces:
java.io.Serializable, TWSHeader
Direct Known Subclasses:
WorkstationClassHeader, WorkstationHeader

public abstract class FlowTargetHeader
extends java.lang.Object
implements TWSHeader

This is a base abstraction for WorkstationHeader and WorkstationClassHeader, hosting the attributes shared by these header classes and shown in TWS external interfaces when listing workstations or workstation classes.

See Also:
FlowTarget, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
protected FlowTargetHeader()
          Creates an empty FlowTargetHeader.
protected FlowTargetHeader(FlowTargetKey flowTargetKey)
          Creates a FlowTargetHeader with the specified key.
protected FlowTargetHeader(Identifier flowTargetId)
          Creates a FlowTargetHeader with the specified identifier.
protected FlowTargetHeader(Identifier flowTargetId, FlowTargetKey flowTargetKey)
          Creates a FlowTargetHeader with the specified identifier and key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this FlowTargetHeader object are equal to those of the given one.
 java.lang.String getDescription()
          Returns the workstation or workstation class description.
 Identifier getId()
          Returns the workstation or workstation class identifier.
 boolean getIncludeInPlan()
          Returns the workstation or workstation class includeInPlan property.
 FlowTargetKey getKey()
          Returns the FlowTargetKey wrapped by this FlowTargetHeader object.
 LockData getLockData()
          Returns the workstation or workstation class lock data.
 ModifyData getModifyData()
          Returns the workstation or workstation class modification data.
 java.lang.String getName()
          Returns the workstation or workstation class name.
 TWSKey getObjectKey()
          Returns the workstation or workstation class key as a TWS key.
 int hashCode()
          Returns a hash code for this FlowTargetHeader object.
 void setDescription(java.lang.String value)
          Sets the workstation or workstation class description.
 void setId(Identifier identifier)
          Sets the workstation or workstation class identifier.
 void setIncludeInPlan(boolean value)
          Sets the workstation or workstation class includeInPlan property.
 void setKey(FlowTargetKey flowTargetKey)
          Sets the FlowTargetKey to be wrapped by this FlowTargetHeader object.
 void setLockData(LockData data)
          Sets the workstation or workstation class lock data.
 void setModifyData(ModifyData data)
          Sets the workstation or workstation class modification data.
 void setName(java.lang.String value)
          Sets the workstation or workstation class name.
 java.lang.String toString()
          Returns a string representation of this FlowTargetHeader 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

FlowTargetHeader

protected FlowTargetHeader()
Creates an empty FlowTargetHeader.


FlowTargetHeader

protected FlowTargetHeader(Identifier flowTargetId)
Creates a FlowTargetHeader with the specified identifier.

Parameters:
flowTargetId - The workstation or workstation class identifier.

FlowTargetHeader

protected FlowTargetHeader(FlowTargetKey flowTargetKey)
Creates a FlowTargetHeader with the specified key.

Parameters:
flowTargetKey - The workstation or workstation class key.

FlowTargetHeader

protected FlowTargetHeader(Identifier flowTargetId,
                           FlowTargetKey flowTargetKey)
Creates a FlowTargetHeader with the specified identifier and key.

Parameters:
flowTargetId - The workstation or workstation class identifier.
flowTargetKey - The workstation or workstation class key.
Method Detail

getId

public Identifier getId()
Returns the workstation or workstation class identifier.

Specified by:
getId in interface TWSHeader
Returns:
The workstation or workstation class identifier.

getObjectKey

public TWSKey getObjectKey()
Returns the workstation or workstation class key as a TWS key.

Specified by:
getObjectKey in interface TWSHeader
Returns:
The workstation or workstation class key as a TWS key.

getKey

public FlowTargetKey getKey()
Returns the FlowTargetKey wrapped by this FlowTargetHeader object.

Returns:
The FlowTargetKey wrapped by this FlowTargetHeader object.

getName

public java.lang.String getName()
Returns the workstation or workstation class name.

Specified by:
getName in interface TWSHeader
Returns:
The workstation or workstation class name.

getDescription

public java.lang.String getDescription()
Returns the workstation or workstation class description.

Returns:
The workstation or workstation class description.

getIncludeInPlan

public boolean getIncludeInPlan()
Returns the workstation or workstation class includeInPlan property.

Returns:
The workstation or workstation class includeInPlan property.

getModifyData

public ModifyData getModifyData()
Returns the workstation or workstation class modification data.

Specified by:
getModifyData in interface TWSHeader
Returns:
The workstation or workstation class modification data.

getLockData

public LockData getLockData()
Returns the workstation or workstation class lock data.

Specified by:
getLockData in interface TWSHeader
Returns:
The workstation or workstation class lock data.

setId

public void setId(Identifier identifier)
Sets the workstation or workstation class identifier.

Parameters:
identifier - The workstation or workstation class identifier.

setKey

public void setKey(FlowTargetKey flowTargetKey)
Sets the FlowTargetKey to be wrapped by this FlowTargetHeader object.

Parameters:
flowTargetKey - The FlowTargetKey to be wrapped by this FlowTargetHeader object.

setName

public void setName(java.lang.String value)
Sets the workstation or workstation class name.

Parameters:
value - The workstation or workstation class name.

setDescription

public void setDescription(java.lang.String value)
Sets the workstation or workstation class description.

Parameters:
value - The workstation or workstation class description.

setIncludeInPlan

public void setIncludeInPlan(boolean value)
Sets the workstation or workstation class includeInPlan property.

Parameters:
value - The workstation or workstation class includeInPlan property.

setModifyData

public void setModifyData(ModifyData data)
Sets the workstation or workstation class modification data. For internal use only.

Parameters:
data - A ModifyData object.

setLockData

public void setLockData(LockData data)
Sets the workstation or workstation class lock data. For internal use only.

Parameters:
data - A LockData object.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all FlowTargetHeader fields.


Copyright © 2005 IBM All Rights Reserved.