com.tibco.cep.runtime.model.event

Interface TimeEvent

All Superinterfaces:

Entity, Event

public interface TimeEvent
extends Event

Base for time-based events.

Since:

2.0.0

See Also:

SimpleEvent

Field Summary

Fields

Modifier and Type	Field and Description
static int	INTERVAL_UNIT_DAYS Represents the time unit: days.
static int	INTERVAL_UNIT_HOURS Represents the time unit: hours.
static int	INTERVAL_UNIT_MILLISECONDS Represents the time unit: milliseconds.
static int	INTERVAL_UNIT_MINUTES Represents the time unit: minutes.
static int	INTERVAL_UNIT_SECONDS Represents the time unit: seconds.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClosure() Gets the closure of this event.
long	getInterval() Gets the repeating interval in milliseconds.
java.util.Calendar	getScheduledTime() Gets the schedule time of this time event.
long	getScheduledTimeMillis() Gets the schedule time of this time event in milliseconds since the epoch.
boolean	isRepeating() Specifies whether the event is a repeating event.
void	setClosure(java.lang.String closure) Sets the closure of this time event.
void	setScheduledTime(java.util.Calendar time) Sets the schedule time of this event.
void	setScheduledTime(long time) Sets the schedule time of this time event.

Methods inherited from interface com.tibco.cep.kernel.model.entity.Event

getTTL, hasExpiryAction, onExpiry

Methods inherited from interface com.tibco.cep.kernel.model.entity.Entity

getExtId, getId

Field Detail

INTERVAL_UNIT_MILLISECONDS

static final int INTERVAL_UNIT_MILLISECONDS

Represents the time unit: milliseconds.

Since:

2.0.0

See Also:

Constant Field Values

INTERVAL_UNIT_SECONDS

static final int INTERVAL_UNIT_SECONDS

Represents the time unit: seconds.

Since:

2.0.0

See Also:

Constant Field Values

INTERVAL_UNIT_MINUTES

static final int INTERVAL_UNIT_MINUTES

Represents the time unit: minutes.

Since:

2.0.0

See Also:

Constant Field Values

INTERVAL_UNIT_HOURS

static final int INTERVAL_UNIT_HOURS

Represents the time unit: hours.

Since:

2.0.0

See Also:

Constant Field Values

INTERVAL_UNIT_DAYS

static final int INTERVAL_UNIT_DAYS

Represents the time unit: days.

Since:

2.0.0

See Also:

Constant Field Values

Method Detail

isRepeating

boolean isRepeating()

Specifies whether the event is a repeating event.

Returns:

true if the event is a repeating event.

Since:

2.0.0

getInterval

long getInterval()

Gets the repeating interval in milliseconds.

Returns:

repeating interval in millseconds.

Since:

2.0.0

setClosure

void setClosure(java.lang.String closure)

Sets the closure of this time event.

Parameters:

closure - the String closure to be set.

Since:

2.0.0

getClosure

java.lang.String getClosure()

Gets the closure of this event.

Returns:

closure of this event.

Since:

2.0.0

setScheduledTime

void setScheduledTime(java.util.Calendar time)

Sets the schedule time of this event.

Parameters:

time - a Calendar specifying the time to schedule.

Since:

2.0.0

setScheduledTime

void setScheduledTime(long time)

Sets the schedule time of this time event.

Parameters:

time - a long specifying the time to schedule in milliseconds since the epoch.

Since:

2.0.0

getScheduledTime

java.util.Calendar getScheduledTime()

Gets the schedule time of this time event.

Returns:

a Calendar specifying the scheduled time of this event.

Since:

2.0.0

getScheduledTimeMillis

long getScheduledTimeMillis()

Gets the schedule time of this time event in milliseconds since the epoch.

Returns:

the schedule time of this time event in milliseconds since the epoch.

Since:

2.0.0