com.ibm.tws.objects.model
Class RunCycle

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

public class RunCycle
extends java.lang.Object
implements TWSObject, TWSHeader

This class models a run cycle and can be used to represent the information about one of the run cycles defined for a job stream. Run cycles are created and modified as part of the job stream to which they belong, therefore RunCycle has no key class and cannot be referenced in any other object except for the job stream where it is included.

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

name Always required
Alphanumeric characters
Starting with alphabetic character
'-' and '_' characters allowed
Blank spaces not allowed
Not longer than 40 characters
description Not longer than 120 characters
type One of the values exposed by the RunCycleType class
Always required
inclusive Default value is true
validFrom Time must be 0AM GMT, but the meaning is "start of day"
Always required
timeRestrictions See TimeRestrictions for constraints on this field
freeDaysRule One of the values exposed by the FreeDaysRule class
Always required
Default value is NONE
iCalendar Required if type is not CALENDAR
Must be null if type is CALENDAR
Must comply with the RFC2445 standard.
calendarKey If type is CALENDAR, must reference an existing calendar
Must be null if type is not CALENDAR
offsetType One of the values exposed by the OffsetType class
Required if type is CALENDAR
Must be null if type is not CALENDAR
offsetValue Must be 0 if type is not CALENDAR

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

name Always required
Alphanumeric characters
Starting with alphabetic character
It is converted to upper case
Blank spaces not allowed
Not longer than 8 characters
If type is SIMPLE, must reference an existing period
description Not longer than 50 characters
type One of the values exposed by the RunCycleType class
Always required
inclusive Default value is true
validFrom Always required
validTo Always required
timeRestrictions See TimeRestrictions for constraints on this field
freeDaysRule One of the values exposed by the FreeDaysRule class
Always required
Default value is NONE
iCalendar N/A
calendarKey N/A
offsetType N/A
offsetValue N/A
repeatEveryTime An amount of time, expressed in milliseconds
repeatEndTime An amount of time, expressed in milliseconds

See Also:
RunCycleType, FreeDaysRule, OffsetType, TimeRestrictions, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
RunCycle()
          Creates an empty RunCycle.
RunCycle(Identifier runCycleId)
          Creates a RunCycle with the specified identifier.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this RunCycle object are equal to those of the given one.
 Identifier getCalendarId()
          Returns the identifier of the calendar by which this run cycle is defined.
 CalendarKey getCalendarKey()
          Returns the key of the calendar by which this run cycle is defined.
 java.lang.String getDescription()
          Returns the run cycle description.
 FreeDaysRule getFreeDaysRule()
          Returns the run cycle free days rule.
 java.lang.String getICalendar()
          Returns the definition of this run cycle as an iCalendar string.
 Identifier getId()
          Returns the run cycle identifier.
 Identifier getJobStreamId()
          Returns the identifier of the job stream to which this run cycle belongs.
 LockData getLockData()
          Returns null, since this object has no lock data.
 ModifyData getModifyData()
          Returns null, since this object has no modification data.
 java.lang.String getName()
          Returns the run cycle name.
 TWSHeader getObjectHeader()
          Returns this object, which also acts as a TWS header.
 TWSKey getObjectKey()
          Returns null, since this object has no key.
 OffsetType getOffsetType()
          Returns the type of offset specified for a calendar-based run cycle.
 int getOffsetValue()
          Returns the offset specified for a calendar-based run cycle.
 long getRepeatEndTime()
          Returns the run cycle repeat end time.
 long getRepeatEveryTime()
          Returns the run cycle repeat every time.
 TimeRestrictions getTimeRestrictions()
          Returns the run cycle time restrictions.
 RunCycleType getType()
          Returns the run cycle type.
 java.util.Date getValidFrom()
          Returns the start date of the run cycle validity period.
 java.util.Date getValidTo()
          Returns the end date of the run cycle validity period.
 java.lang.String getVariableTable()
          Returns the variable table associated to the run cycle.
 int hashCode()
          Returns a hash code for this RunCycle object.
 boolean isInclusive()
          Returns true if this run cycle is inclusive, false if exclusive.
 void setCalendarId(Identifier identifier)
          Sets the identifier of the calendar by which this run cycle is defined.
 void setCalendarKey(CalendarKey key)
          Sets the key of the calendar by which this run cycle is defined.
 void setDescription(java.lang.String value)
          Sets the run cycle description.
 void setFreeDaysRule(FreeDaysRule rule)
          Sets the run cycle free days rule.
 void setICalendar(java.lang.String value)
          Sets the definition of this run cycle as an iCalendar string.
 void setId(Identifier identifier)
          Sets the run cycle identifier.
 void setInclusive(boolean value)
          Sets the property used to decide if this run cycle is inclusive or exclusive.
 void setJobStreamId(Identifier identifier)
          Sets the identifier of the job stream to which this run cycle belongs.
 void setName(java.lang.String value)
          Sets the run cycle name.
 void setOffsetType(OffsetType value)
          Sets the type of offset specified for a calendar-based run cycle.
 void setOffsetValue(int value)
          Sets the offset specified for a calendar-based run cycle.
 void setRepeatEndTime(long value)
          Sets the run cycle repeat end time.
 void setRepeatEveryTime(long value)
          Sets the run cycle repeat every time.
 void setTimeRestrictions(TimeRestrictions restrictions)
          Sets the run cycle time restrictions.
 void setType(RunCycleType value)
          Sets the run cycle type.
 void setValidFrom(java.util.Date value)
          Sets the start date of the run cycle validity period.
 void setValidTo(java.util.Date value)
          Sets the end date of the run cycle validity period.
 void setVariableTable(java.lang.String value)
          Sets the variable table associated to the run cycle.
 java.lang.String toString()
          Returns a string representation of this RunCycle 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

RunCycle

public RunCycle()
Creates an empty RunCycle.


RunCycle

public RunCycle(Identifier runCycleId)
Creates a RunCycle with the specified identifier.

Parameters:
runCycleId - The run cycle identifier.
Method Detail

getId

public Identifier getId()
Returns the run cycle identifier.

Specified by:
getId in interface TWSObject
Returns:
The run cycle identifier.

getObjectKey

public TWSKey getObjectKey()
Returns null, since this object has no key.

Specified by:
getObjectKey in interface TWSObject
Returns:
Null, since this object has no key.

getObjectHeader

public TWSHeader getObjectHeader()
Returns this object, which also acts as a TWS header.

Specified by:
getObjectHeader in interface TWSObject
Returns:
This object, which also acts as a TWS header.

getModifyData

public ModifyData getModifyData()
Returns null, since this object has no modification data.

Specified by:
getModifyData in interface TWSObject
Returns:
Null, since this object has no modification data.

getLockData

public LockData getLockData()
Returns null, since this object has no lock data.

Specified by:
getLockData in interface TWSObject
Returns:
Null, since this object has no lock data.

getName

public java.lang.String getName()
Returns the run cycle name.

Specified by:
getName in interface TWSObject
Returns:
The run cycle name.

getDescription

public java.lang.String getDescription()
Returns the run cycle description.

Returns:
The run cycle description.

getType

public RunCycleType getType()
Returns the run cycle type.

Returns:
The run cycle type.

isInclusive

public boolean isInclusive()
Returns true if this run cycle is inclusive, false if exclusive.

Returns:
True if this run cycle is inclusive, false if exclusive.

getValidFrom

public java.util.Date getValidFrom()
Returns the start date of the run cycle validity period.

Returns:
The start date of the run cycle validity period.

getValidTo

public java.util.Date getValidTo()
Returns the end date of the run cycle validity period.

Returns:
The end date of the run cycle validity period.

getTimeRestrictions

public TimeRestrictions getTimeRestrictions()
Returns the run cycle time restrictions.

Returns:
The run cycle time restrictions.

getFreeDaysRule

public FreeDaysRule getFreeDaysRule()
Returns the run cycle free days rule.

Returns:
The run cycle free days rule.

getICalendar

public java.lang.String getICalendar()
Returns the definition of this run cycle as an iCalendar string.

Returns:
The definition of this run cycle as an iCalendar string.

getCalendarId

public Identifier getCalendarId()
Returns the identifier of the calendar by which this run cycle is defined.

Returns:
The identifier of the calendar by which this run cycle is defined.

getCalendarKey

public CalendarKey getCalendarKey()
Returns the key of the calendar by which this run cycle is defined.

Returns:
The key of the calendar by which this run cycle is defined.

getOffsetType

public OffsetType getOffsetType()
Returns the type of offset specified for a calendar-based run cycle.

Returns:
The type of offset specified for a calendar-based run cycle.

getOffsetValue

public int getOffsetValue()
Returns the offset specified for a calendar-based run cycle.

Returns:
The offset specified for a calendar-based run cycle.

getVariableTable

public java.lang.String getVariableTable()
Returns the variable table associated to the run cycle.

Returns:
The variable table associated to the run cycle.

getJobStreamId

public Identifier getJobStreamId()
Returns the identifier of the job stream to which this run cycle belongs.

Returns:
The identifier of the job stream to which this run cycle belongs.

getRepeatEveryTime

public long getRepeatEveryTime()
Returns the run cycle repeat every time.

Returns:
The run cycle repeat every time.

getRepeatEndTime

public long getRepeatEndTime()
Returns the run cycle repeat end time.

Returns:
The run cycle repeat end time.

setId

public void setId(Identifier identifier)
Sets the run cycle identifier.

Parameters:
identifier - The run cycle identifier.

setName

public void setName(java.lang.String value)
Sets the run cycle name.

Parameters:
value - The run cycle name.

setDescription

public void setDescription(java.lang.String value)
Sets the run cycle description.

Parameters:
value - The run cycle description.

setType

public void setType(RunCycleType value)
Sets the run cycle type.

Parameters:
value - The run cycle type.

setInclusive

public void setInclusive(boolean value)
Sets the property used to decide if this run cycle is inclusive or exclusive.

Parameters:
value - True if this run cycle is inclusive, false if exclusive.

setValidFrom

public void setValidFrom(java.util.Date value)
Sets the start date of the run cycle validity period.

Parameters:
value - The start date of the run cycle validity period.

setValidTo

public void setValidTo(java.util.Date value)
Sets the end date of the run cycle validity period.

Parameters:
value - The end date of the run cycle validity period.

setTimeRestrictions

public void setTimeRestrictions(TimeRestrictions restrictions)
Sets the run cycle time restrictions.

Parameters:
restrictions - The run cycle time restrictions.

setFreeDaysRule

public void setFreeDaysRule(FreeDaysRule rule)
Sets the run cycle free days rule.

Parameters:
rule - The run cycle free days rule.

setICalendar

public void setICalendar(java.lang.String value)
Sets the definition of this run cycle as an iCalendar string.

Parameters:
value - The definition of this run cycle as an iCalendar string.

setCalendarId

public void setCalendarId(Identifier identifier)
Sets the identifier of the calendar by which this run cycle is defined.

Parameters:
identifier - The identifier of the calendar by which this run cycle is defined.

setCalendarKey

public void setCalendarKey(CalendarKey key)
Sets the key of the calendar by which this run cycle is defined.

Parameters:
key - The key of the calendar by which this run cycle is defined.

setOffsetType

public void setOffsetType(OffsetType value)
Sets the type of offset specified for a calendar-based run cycle.

Parameters:
value - The type of offset specified for a calendar-based run cycle.

setOffsetValue

public void setOffsetValue(int value)
Sets the offset specified for a calendar-based run cycle.

Parameters:
value - The offset specified for a calendar-based run cycle.

setVariableTable

public void setVariableTable(java.lang.String value)
Sets the variable table associated to the run cycle.

Parameters:
value - The variable table associated to the run cycle.

setJobStreamId

public void setJobStreamId(Identifier identifier)
Sets the identifier of the job stream to which this run cycle belongs.

Parameters:
identifier - The identifier of the job stream to which this run cycle belongs.

setRepeatEveryTime

public void setRepeatEveryTime(long value)
Sets the run cycle repeat every time.

Parameters:
value - The run cycle repeat every time.

setRepeatEndTime

public void setRepeatEndTime(long value)
Sets the run cycle repeat end time.

Parameters:
value - The run cycle repeat end time.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all RunCycle fields.


Copyright © 2005 IBM All Rights Reserved.