Package org.netxms.client
Class TimePeriod
java.lang.Object
org.netxms.client.TimePeriod
-
Constructor Summary
ConstructorDescriptionDefault constructor.TimePeriod
(TimeFrameType timeFrameType, int timeRange, TimeUnit timeUnit, Date timeFrom, Date timeTo) Create new time period. -
Method Summary
Modifier and TypeMethodDescriptionGet period end calculated from time frame type, time unit, etc.Get period start calculated from time frame type, time unit, etc.Get time frame type ("fixed" or "back from now") for this period.Get starting point in time for this time range.int
Get time range in time units.Get ending point in time for this time range.Get time unit used for defining this time range.boolean
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
Set ending point in time for this time range.void
setTimeUnit
(TimeUnit timeUnit) Set time unit used for defining this time range.toString()
-
Constructor Details
-
TimePeriod
public TimePeriod(TimeFrameType timeFrameType, int timeRange, TimeUnit timeUnit, Date timeFrom, Date timeTo) Create new time period.- Parameters:
timeFrameType
- time frame typetimeRange
- time range length in time unitstimeUnit
- time unit used for defining this rangetimeFrom
- 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.
-
-
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
Get time frame type ("fixed" or "back from now") for this period.- Returns:
- time frame type for this period
-
setTimeFrameType
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
Get time unit used for defining this time range.- Returns:
- time unit used for defining this time range.
-
setTimeUnit
Set time unit used for defining this time range.- Parameters:
timeUnit
- new time unit used for defining this time range.
-
getTimeFrom
Get starting point in time for this time range.- Returns:
- starting point in time for this time range
-
setTimeFrom
Set starting point in time for this time range.- Parameters:
timeFrom
- new starting point in time for this time range
-
getTimeTo
Get ending point in time for this time range.- Returns:
- ending point in time for this time range
-
setTimeTo
Set ending point in time for this time range.- Parameters:
timeTo
- new ending point in time for this time range
-
getPeriodStart
Get period start calculated from time frame type, time unit, etc.- Returns:
- calculated period start
-
getPeriodEnd
Get period end calculated from time frame type, time unit, etc.- Returns:
- calculated period end
-
toString
-