Package com.appiancorp.suiteapi.process
Class Interval
java.lang.Object
com.appiancorp.suiteapi.process.Interval
- All Implemented Interfaces:
XMLable
,Serializable
Interval define a period of time in terms of Minutes, Hours, Days, Weeks,
Months and Years. This class is generally used to define an event
relative to some other event. The actual time period will be summation of
the intervals of all the properties of the Interval class. For example if
Minute interval is 15 mins and Day interval is 10 days and all other
properties are set to null, then the actual time interval will be of 10 days
and 15 mins.
- See Also:
-
Field Summary
Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the time interval in terms of number of daysReturns an expression that will be used to compute the time interval in terms of daysReturns the time interval in terms of number of hoursReturns an expression that will be used to compute the time interval in terms of hoursReturns the time interval in terms of number of minutesReturns an expression that will be used to compute the time interval in terms of minutesReturns the time interval in terms of number of monthsReturns an expression that will be used to compute the time interval in terms of monthsReturns the time interval in terms of number of weeksReturns an expression that will be used to compute the time interval in terms of weeksReturns the time interval in terms of number of yearsReturns an expression that will be used to compute the time interval in terms of yearsvoid
setDayInterval
(Long dayInterval_) Sets the time interval in terms of number of daysvoid
setDayIntervalExpr
(String dayIntervalExpr_) Sets the time interval in terms of number of days, using an expressionvoid
setHourInterval
(Long hourInterval_) Sets the time interval in terms of number of hoursvoid
setHourIntervalExpr
(String hourIntervalExpr_) Sets the time interval in terms of number of hours, using an expressionvoid
setMinInterval
(Long minInterval_) Sets the time interval in terms of number of minutesvoid
setMinIntervalExpr
(String minIntervalExpr_) Sets the time interval in terms of number of minutes, using an expressionvoid
setMonthInterval
(Long monthInterval_) Sets the time interval in terms of number of monthsvoid
setMonthIntervalExpr
(String monthIntervalExpr_) Sets the time interval in terms of number of months, using an expressionvoid
setWeekInterval
(Long weekInterval_) Sets the time interval in terms of number of weeksvoid
setWeekIntervalExpr
(String weekIntervalExpr_) Sets the time interval in terms of number of weeks, using an expressionvoid
setYearInterval
(Long yearInterval_) Sets the time interval in terms of number of years.void
setYearIntervalExpr
(String yearIntervalExpr_) Sets the time interval in terms of number of years, using an expressiontoXML()
Returns String representation of theInterval
object.void
toXML
(StringBuilder buffer_) Appends an XML representation of this object (including all child objects) to the given buffer.
-
Constructor Details
-
Interval
public Interval()
-
-
Method Details
-
getDayInterval
Returns the time interval in terms of number of days- Returns:
- numbers of days in terms of a Long object. Null if the number of days is not set.
-
setDayInterval
Sets the time interval in terms of number of days- Parameters:
dayInterval_
- Long value representing the number of days
-
getHourInterval
Returns the time interval in terms of number of hours- Returns:
- number of hours as a Long object. Null if the number of hours is not set.
-
setHourInterval
Sets the time interval in terms of number of hours- Parameters:
hourInterval_
- Long value representing number of hours
-
getMinInterval
Returns the time interval in terms of number of minutes- Returns:
- number of minutes as a Long object. Null if the number of minutes is not set.
-
setMinInterval
Sets the time interval in terms of number of minutes- Parameters:
minInterval_
- Long value representing the number of minutes
-
getMonthInterval
Returns the time interval in terms of number of months- Returns:
- number of months as a Long object. Null if the number of months is not set.
-
setMonthInterval
Sets the time interval in terms of number of months- Parameters:
monthInterval_
- Long value representing the number of months
-
getWeekInterval
Returns the time interval in terms of number of weeks- Returns:
- number of weeks as a Long object. Null if the number of weeks is not set.
-
setWeekInterval
Sets the time interval in terms of number of weeks- Parameters:
weekInterval_
- Long value representing the number of weeks
-
getYearInterval
Returns the time interval in terms of number of years- Returns:
- number of years as a Long object. Null if the number of years is not set.
-
setYearInterval
Sets the time interval in terms of number of years.- Parameters:
yearInterval_
- Long value representing the number of years
-
getDayIntervalExpr
Returns an expression that will be used to compute the time interval in terms of days- Returns:
- the expression, which should evaluate to an integer
-
setDayIntervalExpr
Sets the time interval in terms of number of days, using an expression- Parameters:
dayIntervalExpr_
- Expression that should evaluate to an integer
-
getHourIntervalExpr
Returns an expression that will be used to compute the time interval in terms of hours- Returns:
- the expression, which should evaluate to an integer
-
setHourIntervalExpr
Sets the time interval in terms of number of hours, using an expression- Parameters:
hourIntervalExpr_
- Expression that should evaluate to an integer
-
getMinIntervalExpr
Returns an expression that will be used to compute the time interval in terms of minutes- Returns:
- the expression, which should evaluate to an integer
-
setMinIntervalExpr
Sets the time interval in terms of number of minutes, using an expression- Parameters:
minIntervalExpr_
- Expression that should evaluate to an integer
-
getMonthIntervalExpr
Returns an expression that will be used to compute the time interval in terms of months- Returns:
- the expression, which should evaluate to an integer
-
setMonthIntervalExpr
Sets the time interval in terms of number of months, using an expression- Parameters:
monthIntervalExpr_
- Expression that should evaluate to an integer
-
getWeekIntervalExpr
Returns an expression that will be used to compute the time interval in terms of weeks- Returns:
- the expression, which should evaluate to an integer
-
setWeekIntervalExpr
Sets the time interval in terms of number of weeks, using an expression- Parameters:
weekIntervalExpr_
- Expression that should evaluate to an integer
-
getYearIntervalExpr
Returns an expression that will be used to compute the time interval in terms of years- Returns:
- the expression, which should evaluate to an integer
-
setYearIntervalExpr
Sets the time interval in terms of number of years, using an expression- Parameters:
yearIntervalExpr_
- Expression that should evaluate to an integer
-
toXML
Returns String representation of theInterval
object. -
toXML
Description copied from interface:XMLable
Appends an XML representation of this object (including all child objects) to the given buffer. Override for performance.
-