com.tibco.cep.runtime.model.element

Interface PropertyAtomDateTime

public interface PropertyAtomDateTime

Property that contains one DateTime i.e. Calendar.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
java.util.Calendar	getDateTime() Gets the current value of this property.
java.util.Calendar	getDateTime(long time) Gets the value that property had at the given time.
java.util.Calendar	getDateTimeAtIdx(int idx) Gets the value of this PropertyAtomDateTime at the given history index.
boolean	setDateTime(java.util.Calendar value) Sets the current value of this PropertyAtom.
boolean	setDateTime(java.util.Calendar value, long time) Sets the value of this PropertyAtom with a given time.

Method Detail

getDateTime

java.util.Calendar getDateTime()

Gets the current value of this property.

Returns:

the current value of this property.

Since:

2.0.0

getDateTime

java.util.Calendar getDateTime(long time)

Gets the value that property had at the given time.

Parameters:

time - a time expressed in number of milliseconds since the epoch.

Returns:

a Calendar value.

Throws:

PropertyException - if the value at the given time is unknown.

Since:

2.0.0

getDateTimeAtIdx

java.util.Calendar getDateTimeAtIdx(int idx)

Gets the value of this PropertyAtomDateTime at the given history index.

Parameters:

idx - index in the history of this property.

Returns:

the value of this property at the given index.

Throws:

PropertyException - if the index is invalid.

Since:

2.0.0

See Also:

Property#getHistoryPolicy(), Property#getHistorySize()

setDateTime

boolean setDateTime(java.util.Calendar value)

Sets the current value of this PropertyAtom.

Parameters:

value - the value to set

Returns:

true if a new entry was added in the history for this value.

Since:

2.0.0

See Also:

Property#getHistoryPolicy()

setDateTime

boolean setDateTime(java.util.Calendar value,
                    long time)

Sets the value of this PropertyAtom with a given time.

Parameters:

value - the value to set.

time - the time to associate with the value.

Returns:

true if a new entry was added in the history for this value.

Since:

2.0.0

See Also:

Property#getHistoryPolicy()