com.uc4.api.objects

Class JobPlanEarliest

java.lang.Object

com.uc4.api.objects.JobPlanEarliest

public class JobPlanEarliest
extends java.lang.Object

This class can be used to specify the earliest starting time for a task in a JobPlan. The task may be marked active or a breakpoint may be set.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JobPlanEarliest(boolean isExternal)
protected	JobPlanEarliest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element task)

Method Summary

Modifier and Type	Method and Description
JobPlanEarliest	copy() Creates a deep copy of this object
int	getDaysAfterJobPlanActivation() Returns the number of days which should be added to the current date as of activation to get the earliest start time.
Time	getTime() Returns the earliest start time.
UC4TimezoneName	getTimezone() Returns the TimeZone that is to be used.
boolean	isActive() Returns true if this task is active.
boolean	isBreakPoint() Returns true if the JobPlan should stop at this task.
boolean	isEarliestStart() Returns true if an earliest start check is enabled for this JobPlan task.
void	setActive(boolean active) Sets this task active or inactive.
void	setBreakPoint(boolean breakPoint) Sets or clears the breakpoint.
void	setDaysAfterJobPlanActivation(int daysAfterJobPlanActivation) Sets the number of days which should be added to the current date as of activation to get the earliest start time.
void	setEarliestStart(boolean earliestStart) Enables or disables the check for the earliest start time.
void	setTime(Time time) Sets the earliest start time.
void	setTimezone(UC4TimezoneName timezone) Sets the TimeZone that is to be used.
protected void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element task)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobPlanEarliest

protected JobPlanEarliest(boolean isExternal)

JobPlanEarliest

protected JobPlanEarliest(com.uc4.util.XMLDocument doc,
                          org.w3c.dom.Element task)

Method Detail

store

protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element task)

isActive

public boolean isActive()

Returns true if this task is active.

Returns:

True if this task is active

setActive

public void setActive(boolean active)

Sets this task active or inactive.

Parameters:

active - Boolean value which true if this task should be active

getDaysAfterJobPlanActivation

public int getDaysAfterJobPlanActivation()

Returns the number of days which should be added to the current date as of activation to get the earliest start time.

Returns:

Number of days as of JobPlan activation

setDaysAfterJobPlanActivation

public void setDaysAfterJobPlanActivation(int daysAfterJobPlanActivation)

Sets the number of days which should be added to the current date as of activation to get the earliest start time.

Parameters:

daysAfterJobPlanActivation - Number of days as of JobPlan activation

isEarliestStart

public boolean isEarliestStart()

Returns true if an earliest start check is enabled for this JobPlan task.

Returns:

True if earliest start is enabled

setEarliestStart

public void setEarliestStart(boolean earliestStart)

Enables or disables the check for the earliest start time.

Parameters:

earliestStart - Boolean value which true if earliest start should be checked

getTime

public Time getTime()

Returns the earliest start time.

Returns:

Earliest start time

setTime

public void setTime(Time time)

Sets the earliest start time. If the task is ready to start but the time specified for the earliest start has not yet been reached, this task goes into a "waiting" condition. Its status is "Waiting for start time".

Parameters:

time - Start time

isBreakPoint

public boolean isBreakPoint()

Returns true if the JobPlan should stop at this task. To continue, the breakpoint in the JobPlan Monitor must be deleted manually.

Returns:

True if a break point is set

setBreakPoint

public void setBreakPoint(boolean breakPoint)

Sets or clears the breakpoint. If breakPoint is set to true the JobPlan is stopped at this task. To continue, the breakpoint in the JobPlan Monitor must be deleted manually.

Parameters:

breakPoint - Boolean value which true if a break point should be set

getTimezone

public UC4TimezoneName getTimezone()

Returns the TimeZone that is to be used.

Returns:

TimeZone

setTimezone

public void setTimezone(UC4TimezoneName timezone)

Sets the TimeZone that is to be used.

Parameters:

timezone - TimeZone

copy

public JobPlanEarliest copy()

Creates a deep copy of this object

Returns:

A copy of this object