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

java.lang.Object
  extended bycom.ibm.tws.objects.types.AbstractTimeRestrictions
      extended bycom.ibm.tws.objects.model.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 run cycle.

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

isTimeDependent Default value is false
startOffset An amount of time, expressed in milliseconds
Allowed range is from 0 to 8,640,000,000 (0-100 days)
Lower than latestStartOffset (in the same day)
Default is TypeUtility.NULL_OFFSET, used as a null value
deadlineOffset An amount of time, expressed in milliseconds
Allowed range is from 0 to 8,640,000,000 (0-100 days)
Default is TypeUtility.NULL_OFFSET, used as a null value
latestStartOffset An amount of time, expressed in milliseconds
Allowed range is from 0 to 8,640,000,000 (0-100 days)
Lower than deadlineOffset (in the same day)
Default is TypeUtility.NULL_OFFSET, used as a null value
latestStartAction One of the values exposed by the LateAction class
Required if latestStartOffset is specified
Must be null if latestStartOffset is missing

The following syntax validation constraints must be met on TimeRestrictions objects in z/OS environment:

isTimeDependent Default value is false
startOffset An amount of time, expressed in milliseconds
Allowed range is from 0 to 8,640,000,000 (0-100 days)
Lower than latestStartOffset (in the same day)
Default is TypeUtility.NULL_OFFSET, used as a null value
deadlineOffset An amount of time, expressed in milliseconds
Allowed range is from 0 to 8,640,000,000 (0-100 days)
Default is TypeUtility.NULL_OFFSET, used as a null value
latestStartOffset N/A
latestStartAction N/A

See Also:
LateAction, TypeUtility, 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.
 long getDeadlineOffset()
          Returns the deadline offset.
 long getLatestStartOffset()
          Returns the latest start offset.
 long getStartOffset()
          Returns the start offset.
 int hashCode()
          Returns a hash code for this TimeRestrictions object.
 void setDeadlineOffset(long value)
          Sets the deadline offset.
 void setLatestStartOffset(long value)
          Sets the latest start offset.
 void setStartOffset(long value)
          Sets the start offset.
 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

getStartOffset

public long getStartOffset()
Returns the start offset.

Returns:
The start offset.

getDeadlineOffset

public long getDeadlineOffset()
Returns the deadline offset.

Returns:
The deadline offset.

getLatestStartOffset

public long getLatestStartOffset()
Returns the latest start offset.

Returns:
The latest start offset.

setStartOffset

public void setStartOffset(long value)
Sets the start offset.

Parameters:
value - The start offset.

setDeadlineOffset

public void setDeadlineOffset(long value)
Sets the deadline offset.

Parameters:
value - The deadline offset.

setLatestStartOffset

public void setLatestStartOffset(long value)
Sets the latest start offset.

Parameters:
value - The latest start offset.

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.


Copyright © 2005 IBM All Rights Reserved.