com.ibm.tws.objects.plan.types
Class TimeRestrictions

java.lang.Object
  extended bycom.ibm.tws.objects.types.AbstractTimeRestrictions
      extended bycom.ibm.tws.objects.plan.types.TimeRestrictions
All Implemented Interfaces:
java.io.Serializable

public class TimeRestrictions
extends AbstractTimeRestrictions

This class includes the information required to describe the time restrictions of a job or of a job stream in the plan. In the plan these information becomes real times and no more temporal offset, then values that in com.ibm.tws.objects.plan.types.TimeRestrictions are longs here are Dates.

The following syntax validation constraints must be met on TimeRestrictions objects in distributed environment:

isTimeDependent Inherited; Default value is false
startTime Default value is null. If specified
it should be lower than untilTime,
even if no check the on server is performed.
deadlineTime Default value is null. If specified
it should be greater than untilTime,
even if no check on the server is performed.
untilTime Default value is null. If specified
it should be greater than startTime and
lower than deadlineTime,
even if no check on the server is performed.
latestStartAction Inherited; One of the values exposed by the LateAction class

The following syntax validation constraints must be met on TimeRestrictions objects in Zos environment:

* *
isTimeDependent Inherited; Default value is false
startTime Default value is null. If specified
it should be lower than deadlineTime.
deadlineTime Default value is null. If specified
it should be greater than startTime,
untilTime N/A
latestStartAction N/A

See Also:
LateAction, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
TimeRestrictions()
          Creates an empty TimeRestrictions object.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this TimeRestrictions object are equal to those of the given one.
 java.util.Date getDeadlineTime()
          Returns the Deadline Time Date.
 java.util.Date getStartTime()
          Returns the Start Time Date
 java.util.Date getUntilTime()
          Returns the Until Time Date
 int hashCode()
          Returns a hash code for this TimeRestrictions object.
 void setDeadlineTime(java.util.Date date)
          Sets the Deadline Time Date
 void setStartTime(java.util.Date date)
          Sets the Start Time Date
 void setUntilTime(java.util.Date date)
          Sets the Until Time Date.
 java.lang.String toString()
          Returns a string representation of this TimeRestrictions object.
 
Methods inherited from class com.ibm.tws.objects.types.AbstractTimeRestrictions
getLatestStartAction, isTimeDependent, setLatestStartAction, setTimeDependent
 
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

TimeRestrictions

public TimeRestrictions()
Creates an empty TimeRestrictions object.

Method Detail

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this TimeRestrictions object are equal to those of the given one.

Overrides:
equals in class AbstractTimeRestrictions
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 TimeRestrictions object.

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

toString

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

Overrides:
toString in class AbstractTimeRestrictions
Returns:
A text string including all TimeRestrictions fields.

getDeadlineTime

public java.util.Date getDeadlineTime()
Returns the Deadline Time Date.

Returns:
the Deadline Time Date

getStartTime

public java.util.Date getStartTime()
Returns the Start Time Date

Returns:
the Start Time Date.

getUntilTime

public java.util.Date getUntilTime()
Returns the Until Time Date

Returns:
the Until Time Date

setDeadlineTime

public void setDeadlineTime(java.util.Date date)
Sets the Deadline Time Date

Parameters:
date - the Deadline Time Date to set

setStartTime

public void setStartTime(java.util.Date date)
Sets the Start Time Date

Parameters:
date - the Start Time Date to set

setUntilTime

public void setUntilTime(java.util.Date date)
Sets the Until Time Date.

Parameters:
date - the Until Time Date to set.


Copyright © 2005 IBM All Rights Reserved.