Package org.netxms.client

Class TimePeriod

java.lang.Object

org.netxms.client.TimePeriod

public class TimePeriod
extends Object

Constructor Summary

Constructors

Constructor	Description
TimePeriod()	Default constructor.
TimePeriod(TimeFrameType timeFrameType, int timeRange, TimeUnit timeUnit, Date timeFrom, Date timeTo)	Create new time period.
TimePeriod(TimePeriod src)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
Date	getPeriodEnd()	Get period end calculated from time frame type, time unit, etc.
Date	getPeriodStart()	Get period start calculated from time frame type, time unit, etc.
TimeFrameType	getTimeFrameType()	Get time frame type ("fixed" or "back from now") for this period.
Date	getTimeFrom()	Get starting point in time for this time range.
int	getTimeRange()	Get time range in time units.
Date	getTimeTo()	Get ending point in time for this time range.
TimeUnit	getTimeUnit()	Get time unit used for defining this time range.
boolean	isBackFromNow()	Check if period time frame type is "back from now".
void	setTimeFrameType(TimeFrameType timeFrameType)	Set time frame type ("fixed" or "back from now") for this period.
void	setTimeFrom(Date timeFrom)	Set starting point in time for this time range.
void	setTimeRange(int timeRange)	Set time range in time units.
void	setTimeTo(Date timeTo)	Set ending point in time for this time range.
void	setTimeUnit(TimeUnit timeUnit)	Set time unit used for defining this time range.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TimePeriod

public TimePeriod(TimeFrameType timeFrameType,
 int timeRange,
 TimeUnit timeUnit,
 Date timeFrom,
 Date timeTo)

Create new time period.

Parameters:

timeFrameType - time frame type

timeRange - time range length in time units

timeUnit - time unit used for defining this range

timeFrom - start point in time for fixed period, can be null for "back from now"

timeTo - end point in time for fixed period, can be null for "back from now"

TimePeriod

public TimePeriod()

Default constructor. Created "back from now" type time period with 1 hour length.

TimePeriod

public TimePeriod(TimePeriod src)

Copy constructor.

Parameters:

src - time period to copy

Method Details

isBackFromNow

public boolean isBackFromNow()

Check if period time frame type is "back from now".

Returns:

true if period time frame type is "back from now"

getTimeFrameType

public TimeFrameType getTimeFrameType()

Get time frame type ("fixed" or "back from now") for this period.

Returns:

time frame type for this period

setTimeFrameType

public void setTimeFrameType(TimeFrameType timeFrameType)

Set time frame type ("fixed" or "back from now") for this period.

Parameters:

timeFrameType - new time frame type for this period

getTimeRange

public int getTimeRange()

Get time range in time units.

Returns:

time range in time units

setTimeRange

public void setTimeRange(int timeRange)

Set time range in time units.

Parameters:

timeRange - new time range in time units

getTimeUnit

public TimeUnit getTimeUnit()

Get time unit used for defining this time range.

Returns:

time unit used for defining this time range.

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

Set time unit used for defining this time range.

Parameters:

timeUnit - new time unit used for defining this time range.

getTimeFrom

public Date getTimeFrom()

Get starting point in time for this time range.

Returns:

starting point in time for this time range

setTimeFrom

public void setTimeFrom(Date timeFrom)

Set starting point in time for this time range.

Parameters:

timeFrom - new starting point in time for this time range

getTimeTo

public Date getTimeTo()

Get ending point in time for this time range.

Returns:

ending point in time for this time range

setTimeTo

public void setTimeTo(Date timeTo)

Set ending point in time for this time range.

Parameters:

timeTo - new ending point in time for this time range

getPeriodStart

public Date getPeriodStart()

Get period start calculated from time frame type, time unit, etc.

Returns:

calculated period start

getPeriodEnd

public Date getPeriodEnd()

Get period end calculated from time frame type, time unit, etc.

Returns:

calculated period end

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()