com.ibm.tws.objects.model
Class JobStreamHeader

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

public class JobStreamHeader
extends FlowNodeHeader

This subclass of FlowNodeHeader hosts the attributes to be shown by TWS external interfaces when listing job streams in addition to those already hosted by the FlowNodeHeader class.

See Also:
JobStream, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
static int NO_LIMIT
          The constant used to check for unbounded job stream limit.
 
Fields inherited from class com.ibm.tws.objects.model.FlowNodeHeader
DEFAULT_PRIORITY
 
Constructor Summary
JobStreamHeader()
          Creates an empty JobStreamHeader.
JobStreamHeader(Identifier jobStreamId)
          Creates a JobStreamHeader with the specified identifier.
JobStreamHeader(Identifier jobStreamId, JobStreamKey jobStreamKey)
          Creates a JobStreamHeader with the specified identifier and key.
JobStreamHeader(JobStreamKey jobStreamKey)
          Creates a JobStreamHeader with the specified key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this JobStreamHeader object are equal to those of the given one.
 java.lang.String getAuthorityGroup()
          Returns the job stream authority group.
 boolean getCarryForward()
          Returns the job stream carryForward property.
 int getDeadlineLimitFeedback()
          Returns the job stream deadline limit feedback.
 int getDeadlineSmoothingFactor()
          Returns the job stream deadline smoothing factor.
 FlowTargetKey getFlowTargetKey()
          Returns the key of the workstation or workstation class referenced by this job stream.
 CalendarKey getFreeDaysCalendarKey()
          Returns the key of the free days calendar used with this job stream.
 java.lang.String getGroupName()
          Returns the job stream group name.
 int getLimit()
          Returns the job stream limit.
 LockData getLockData()
          Returns the job stream lock data.
 ModifyData getModifyData()
          Returns the job stream modification data.
 java.lang.String getNextTimeZone()
          Returns the time zone of the following job stream version.
 java.lang.String getOwnerDescription()
          Returns the job stream owner description.
 java.lang.String getOwnerName()
          Returns the job stream owner name.
 java.util.Date getValidFrom()
          Returns the start date of the job stream validity period.
 java.util.Date getValidTo()
          Returns the end date of the job stream validity period.
 int hashCode()
          Returns a hash code for this JobStreamHeader object.
 boolean isDraft()
          Returns true if this job stream is a draft one.
 boolean isGroup()
          Returns true if this job stream is a group of job streams.
 void setAuthorityGroup(java.lang.String value)
          Sets the job stream authority group.
 void setCarryForward(boolean value)
          Sets the job stream carryForward property.
 void setDeadlineLimitFeedback(int value)
          Sets the deadline limit feedback used with this job stream.
 void setDeadlineSmoothingFactor(int value)
          Sets the deadline smoothing factor used with this job stream.
 void setDraft(boolean value)
          Sets the property used to decide if this job stream is a draft one.
 void setFlowTargetKey(FlowTargetKey key)
          Sets the key of the workstation or workstation class referenced by this job stream.
 void setFreeDaysCalendarKey(CalendarKey key)
          Sets the key of the free days calendar used with this job stream.
 void setGroup(boolean value)
          Sets the property used to decide if this job stream is a group of job streams.
 void setGroupName(java.lang.String value)
          Sets the job stream group name.
 void setLimit(int value)
          Sets the job stream limit.
 void setLockData(LockData data)
          Sets the job stream lock data.
 void setModifyData(ModifyData data)
          Sets the job stream modification data.
 void setNextTimeZone(java.lang.String value)
          Sets the time zone of the following job stream version.
 void setOwnerDescription(java.lang.String value)
          Sets the job stream owner description.
 void setOwnerName(java.lang.String value)
          Sets the job stream owner name.
 void setValidFrom(java.util.Date value)
          Sets the start date of the job stream validity period.
 void setValidTo(java.util.Date value)
          Sets the end date of the job stream validity period.
 java.lang.String toString()
          Returns a string representation of this JobStreamHeader object.
 
Methods inherited from class com.ibm.tws.objects.model.FlowNodeHeader
getDescription, getId, getKey, getName, getObjectKey, getPriority, getTimeZone, setDescription, setId, setKey, setName, setPriority, setTimeZone
 
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.


NO_LIMIT

public static final int NO_LIMIT
The constant used to check for unbounded job stream limit.

See Also:
Constant Field Values
Constructor Detail

JobStreamHeader

public JobStreamHeader()
Creates an empty JobStreamHeader.


JobStreamHeader

public JobStreamHeader(Identifier jobStreamId)
Creates a JobStreamHeader with the specified identifier.

Parameters:
jobStreamId - The job stream identifier.

JobStreamHeader

public JobStreamHeader(JobStreamKey jobStreamKey)
Creates a JobStreamHeader with the specified key.

Parameters:
jobStreamKey - The job stream key.

JobStreamHeader

public JobStreamHeader(Identifier jobStreamId,
                       JobStreamKey jobStreamKey)
Creates a JobStreamHeader with the specified identifier and key.

Parameters:
jobStreamId - The job stream identifier.
jobStreamKey - The job stream key.
Method Detail

getFlowTargetKey

public FlowTargetKey getFlowTargetKey()
Returns the key of the workstation or workstation class referenced by this job stream.

Returns:
The key of the workstation or workstation class referenced by this job stream.

getValidFrom

public java.util.Date getValidFrom()
Returns the start date of the job stream validity period.

Returns:
The start date of the job stream validity period.

getValidTo

public java.util.Date getValidTo()
Returns the end date of the job stream validity period.

Returns:
The end date of the job stream validity period.

getNextTimeZone

public java.lang.String getNextTimeZone()
Returns the time zone of the following job stream version.

Returns:
The time zone of the following job stream version.

isDraft

public boolean isDraft()
Returns true if this job stream is a draft one.

Returns:
True if this job stream is a draft one.

getCarryForward

public boolean getCarryForward()
Returns the job stream carryForward property.

Returns:
The job stream carryForward property.

getLimit

public int getLimit()
Returns the job stream limit.

Returns:
The job stream limit.

isGroup

public boolean isGroup()
Returns true if this job stream is a group of job streams.

Returns:
True if this job stream is a group of job streams.

getGroupName

public java.lang.String getGroupName()
Returns the job stream group name.

Returns:
The job stream group name.

getOwnerName

public java.lang.String getOwnerName()
Returns the job stream owner name.

Returns:
The job stream owner name.

getOwnerDescription

public java.lang.String getOwnerDescription()
Returns the job stream owner description.

Returns:
The job stream owner description.

getAuthorityGroup

public java.lang.String getAuthorityGroup()
Returns the job stream authority group.

Returns:
The job stream authority group.

getFreeDaysCalendarKey

public CalendarKey getFreeDaysCalendarKey()
Returns the key of the free days calendar used with this job stream.

Returns:
The key of the free days calendar used with this job stream.

getDeadlineSmoothingFactor

public int getDeadlineSmoothingFactor()
Returns the job stream deadline smoothing factor.

Returns:
The job stream deadline smoothing factor.

getDeadlineLimitFeedback

public int getDeadlineLimitFeedback()
Returns the job stream deadline limit feedback.

Returns:
The job stream deadline limit feedback.

getModifyData

public ModifyData getModifyData()
Returns the job stream modification data.

Returns:
The job stream modification data.

getLockData

public LockData getLockData()
Returns the job stream lock data.

Returns:
The job stream lock data.

setFlowTargetKey

public void setFlowTargetKey(FlowTargetKey key)
Sets the key of the workstation or workstation class referenced by this job stream.

Parameters:
key - The key of the workstation or workstation class referenced by this job stream.

setValidFrom

public void setValidFrom(java.util.Date value)
Sets the start date of the job stream validity period. Values stored on the database are truncated to GMT midnight.

Parameters:
value - The start date of the job stream validity period.

setValidTo

public void setValidTo(java.util.Date value)
Sets the end date of the job stream validity period. For internal use only.

Parameters:
value - The end date of the job stream validity period.

setNextTimeZone

public void setNextTimeZone(java.lang.String value)
Sets the time zone of the following job stream version. For internal use only.

Parameters:
value - The time zone of the following job stream version.

setDraft

public void setDraft(boolean value)
Sets the property used to decide if this job stream is a draft one.

Parameters:
value - True if this job stream is a draft one.

setCarryForward

public void setCarryForward(boolean value)
Sets the job stream carryForward property.

Parameters:
value - The job stream carryForward property.

setLimit

public void setLimit(int value)
Sets the job stream limit.

Parameters:
value - The job stream limit.

setGroup

public void setGroup(boolean value)
Sets the property used to decide if this job stream is a group of job streams.

Parameters:
value - True if this job stream is a group of job streams.

setGroupName

public void setGroupName(java.lang.String value)
Sets the job stream group name.

Parameters:
value - The job stream group name.

setOwnerName

public void setOwnerName(java.lang.String value)
Sets the job stream owner name.

Parameters:
value - The job stream owner name.

setOwnerDescription

public void setOwnerDescription(java.lang.String value)
Sets the job stream owner description.

Parameters:
value - The job stream owner description.

setAuthorityGroup

public void setAuthorityGroup(java.lang.String value)
Sets the job stream authority group.

Parameters:
value - The job stream authority group.

setFreeDaysCalendarKey

public void setFreeDaysCalendarKey(CalendarKey key)
Sets the key of the free days calendar used with this job stream.

Parameters:
key - The key of the free days calendar used with this job stream.

setDeadlineSmoothingFactor

public void setDeadlineSmoothingFactor(int value)
Sets the deadline smoothing factor used with this job stream.

Parameters:
value - The deadline smoothing factor used with this job stream.

setDeadlineLimitFeedback

public void setDeadlineLimitFeedback(int value)
Sets the deadline limit feedback used with this job stream.

Parameters:
value - The deadline limit feedback used with this job stream.

setModifyData

public void setModifyData(ModifyData data)
Sets the job stream modification data. For internal use only.

Parameters:
data - A ModifyData object.

setLockData

public void setLockData(LockData data)
Sets the job stream 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 JobStreamHeader object are equal to those of the given one.

Overrides:
equals in class FlowNodeHeader
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 JobStreamHeader object.

Overrides:
hashCode in class FlowNodeHeader
Returns:
The object's hash code.

toString

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

Overrides:
toString in class FlowNodeHeader
Returns:
A text string including all JobStreamHeader fields.


Copyright © 2005 IBM All Rights Reserved.