com.ibm.tws.objects.model
Class FlowTarget

java.lang.Object
  extended bycom.ibm.tws.objects.model.FlowTarget
All Implemented Interfaces:
java.io.Serializable, TWSObject
Direct Known Subclasses:
Workstation, WorkstationClass

public abstract class FlowTarget
extends java.lang.Object
implements TWSObject

This is a base abstraction for Workstation and WorkstationClass. It wraps a FlowTargetHeader that in turn wraps a FlowTargetKey, and hosts the attributes shared by Workstation and WorkstationClass objects.

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

name Always required
Alphanumeric characters
Starting with alphabetic character
'-' and '_' characters allowed
Blank spaces not allowed
Not longer than 16 characters
description Not longer than 120 characters
includeInPlan Default value is true

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
protected FlowTarget(FlowTargetHeader flowTargetHeader)
          Creates a FlowTarget with the specified header.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this FlowTarget object are equal to those of the given one.
 java.lang.String getDescription()
          Returns the workstation or workstation class description.
 FlowTargetHeader getHeader()
          Returns the FlowTargetHeader wrapped by this FlowTarget object.
 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 FlowTarget 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.
 TWSHeader getObjectHeader()
          Returns the workstation or workstation class header as a TWS header.
 TWSKey getObjectKey()
          Returns the workstation or workstation class key as a TWS key.
 int hashCode()
          Returns a hash code for this FlowTarget object.
 void setDescription(java.lang.String value)
          Sets the workstation or workstation class description.
 void setHeader(FlowTargetHeader flowTargetHeader)
          Sets the FlowTargetHeader to be wrapped by this FlowTarget object.
 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 FlowTarget 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 FlowTarget 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

FlowTarget

protected FlowTarget(FlowTargetHeader flowTargetHeader)
Creates a FlowTarget with the specified header.

Parameters:
flowTargetHeader - The workstation or workstation class header.
Method Detail

getId

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

Specified by:
getId in interface TWSObject
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 TWSObject
Returns:
The workstation or workstation class key as a TWS key.

getObjectHeader

public TWSHeader getObjectHeader()
Returns the workstation or workstation class header as a TWS header.

Specified by:
getObjectHeader in interface TWSObject
Returns:
The workstation or workstation class header as a TWS header.

getKey

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

Returns:
The FlowTargetKey wrapped by this FlowTarget object.

getHeader

public FlowTargetHeader getHeader()
Returns the FlowTargetHeader wrapped by this FlowTarget object.

Returns:
The FlowTargetHeader wrapped by this FlowTarget object.

getName

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

Specified by:
getName in interface TWSObject
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 TWSObject
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 TWSObject
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 FlowTarget object.

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

setHeader

public void setHeader(FlowTargetHeader flowTargetHeader)
Sets the FlowTargetHeader to be wrapped by this FlowTarget object.

Parameters:
flowTargetHeader - The FlowTargetHeader to be wrapped by this FlowTarget 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 FlowTarget 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 FlowTarget object.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all FlowTarget fields.


Copyright © 2005 IBM All Rights Reserved.