com.ibm.tws.objects.model
Class FlowNodeHeader

java.lang.Object
  extended bycom.ibm.tws.objects.model.FlowNodeHeader
All Implemented Interfaces:
java.io.Serializable, TWSHeader
Direct Known Subclasses:
JobHeader, JobStreamHeader

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

This is a base abstraction for JobStreamHeader and JobHeader, hosting the attributes shared by these header classes and shown in TWS external interfaces when listing job streams or jobs respectively.

See Also:
FlowNode, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
static int DEFAULT_PRIORITY
          The default priority for jobs and job streams.
 
Constructor Summary
protected FlowNodeHeader(FlowNodeKey flowNodeKey)
          Creates a FlowNodeHeader with the specified key.
protected FlowNodeHeader(Identifier flowNodeId, FlowNodeKey flowNodeKey)
          Creates a FlowNodeHeader with the specified identifier and key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this FlowNodeHeader object are equal to those of the given one.
 java.lang.String getDescription()
          Returns the job stream or job description.
 Identifier getId()
          Returns the job stream or job identifier.
 FlowNodeKey getKey()
          Returns the FlowNodeKey wrapped by this FlowNodeHeader object.
 java.lang.String getName()
          Returns the job stream or job name.
 TWSKey getObjectKey()
          Returns the job stream or job key as a TWS key.
 int getPriority()
          Returns the job stream or job priority.
 java.lang.String getTimeZone()
          Returns the job stream or job timezone.
 int hashCode()
          Returns a hash code for this FlowNodeHeader object.
 void setDescription(java.lang.String value)
          Sets the job stream or job description.
 void setId(Identifier identifier)
          Sets the job stream or job identifier.
 void setKey(FlowNodeKey flowNodeKey)
          Sets the FlowNodeKey to be wrapped by this FlowNodeHeader object.
 void setName(java.lang.String value)
          Sets the job stream or job name.
 void setPriority(int value)
          Sets the job stream or job priority.
 void setTimeZone(java.lang.String value)
          Sets the job stream or job timezone.
 java.lang.String toString()
          Returns a string representation of this FlowNodeHeader object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.tws.objects.TWSHeader
getLockData, getModifyData
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.


DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY
The default priority for jobs and job streams.

See Also:
Constant Field Values
Constructor Detail

FlowNodeHeader

protected FlowNodeHeader(FlowNodeKey flowNodeKey)
Creates a FlowNodeHeader with the specified key.

Parameters:
flowNodeKey - The job stream or job key.

FlowNodeHeader

protected FlowNodeHeader(Identifier flowNodeId,
                         FlowNodeKey flowNodeKey)
Creates a FlowNodeHeader with the specified identifier and key.

Parameters:
flowNodeId - The job stream or job identifier.
flowNodeKey - The job stream or job key.
Method Detail

getId

public Identifier getId()
Returns the job stream or job identifier.

Specified by:
getId in interface TWSHeader
Returns:
The job stream or job identifier.

getObjectKey

public TWSKey getObjectKey()
Returns the job stream or job key as a TWS key.

Specified by:
getObjectKey in interface TWSHeader
Returns:
The job stream or job key as a TWS key.

getKey

public FlowNodeKey getKey()
Returns the FlowNodeKey wrapped by this FlowNodeHeader object.

Returns:
The FlowNodeKey wrapped by this FlowNodeHeader object.

getName

public java.lang.String getName()
Returns the job stream or job name.

Specified by:
getName in interface TWSHeader
Returns:
The job stream or job name.

getDescription

public java.lang.String getDescription()
Returns the job stream or job description.

Returns:
The job stream or job description.

getPriority

public int getPriority()
Returns the job stream or job priority.

Returns:
The job stream or job priority.

getTimeZone

public java.lang.String getTimeZone()
Returns the job stream or job timezone.

Returns:
The job stream or job timezone.

setId

public void setId(Identifier identifier)
Sets the job stream or job identifier.

Parameters:
identifier - The job stream or job identifier.

setKey

public void setKey(FlowNodeKey flowNodeKey)
Sets the FlowNodeKey to be wrapped by this FlowNodeHeader object.

Parameters:
flowNodeKey - The FlowNodeKey to be wrapped by this FlowNodeHeader object.

setName

public void setName(java.lang.String value)
Sets the job stream or job name.

Parameters:
value - The job stream or job name.

setDescription

public void setDescription(java.lang.String value)
Sets the job stream or job description.

Parameters:
value - The job stream or job description.

setPriority

public void setPriority(int value)
Sets the job stream or job priority.

Parameters:
value - The job stream or job priority.

setTimeZone

public void setTimeZone(java.lang.String value)
Sets the job stream or job timezone.

Parameters:
value - The job stream or job timezone.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all FlowNodeHeader fields.


Copyright © 2005 IBM All Rights Reserved.