Interval (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.process.Interval

All Implemented Interfaces:

XMLable, java.io.Serializable
```
public class Interval
extends java.lang.Object
implements XMLable, java.io.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:

Serialized Form

Field Summary
- Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
  DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors
Constructor and Description

Interval()

Constructors
Constructor and Description
`Interval()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Long`	`getDayInterval()` Returns the time interval in terms of number of days
`java.lang.String`	`getDayIntervalExpr()` Returns an expression that will be used to compute the time interval in terms of days
`java.lang.Long`	`getHourInterval()` Returns the time interval in terms of number of hours
`java.lang.String`	`getHourIntervalExpr()` Returns an expression that will be used to compute the time interval in terms of hours
`java.lang.Long`	`getMinInterval()` Returns the time interval in terms of number of minutes
`java.lang.String`	`getMinIntervalExpr()` Returns an expression that will be used to compute the time interval in terms of minutes
`java.lang.Long`	`getMonthInterval()` Returns the time interval in terms of number of months
`java.lang.String`	`getMonthIntervalExpr()` Returns an expression that will be used to compute the time interval in terms of months
`java.lang.Long`	`getWeekInterval()` Returns the time interval in terms of number of weeks
`java.lang.String`	`getWeekIntervalExpr()` Returns an expression that will be used to compute the time interval in terms of weeks
`java.lang.Long`	`getYearInterval()` Returns the time interval in terms of number of years
`java.lang.String`	`getYearIntervalExpr()` Returns an expression that will be used to compute the time interval in terms of years
`void`	`setDayInterval(java.lang.Long dayInterval_)` Sets the time interval in terms of number of days
`void`	`setDayIntervalExpr(java.lang.String dayIntervalExpr_)` Sets the time interval in terms of number of days, using an expression
`void`	`setHourInterval(java.lang.Long hourInterval_)` Sets the time interval in terms of number of hours
`void`	`setHourIntervalExpr(java.lang.String hourIntervalExpr_)` Sets the time interval in terms of number of hours, using an expression
`void`	`setMinInterval(java.lang.Long minInterval_)` Sets the time interval in terms of number of minutes
`void`	`setMinIntervalExpr(java.lang.String minIntervalExpr_)` Sets the time interval in terms of number of minutes, using an expression
`void`	`setMonthInterval(java.lang.Long monthInterval_)` Sets the time interval in terms of number of months
`void`	`setMonthIntervalExpr(java.lang.String monthIntervalExpr_)` Sets the time interval in terms of number of months, using an expression
`void`	`setWeekInterval(java.lang.Long weekInterval_)` Sets the time interval in terms of number of weeks
`void`	`setWeekIntervalExpr(java.lang.String weekIntervalExpr_)` Sets the time interval in terms of number of weeks, using an expression
`void`	`setYearInterval(java.lang.Long yearInterval_)` Sets the time interval in terms of number of years.
`void`	`setYearIntervalExpr(java.lang.String yearIntervalExpr_)` Sets the time interval in terms of number of years, using an expression
`java.lang.String`	`toXML()` Returns String representation of the `Interval` object.
`void`	`toXML(java.lang.StringBuilder buffer_)` Appends an XML representation of this object (including all child objects) to the given buffer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable
toXML

- Constructor Detail
  - Interval
```
public Interval()
```
- Method Detail
  - getDayInterval
```
public java.lang.Long 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
```
public void setDayInterval(java.lang.Long dayInterval_)
```
    Sets the time interval in terms of number of days
    
    Parameters:
    
    dayInterval_ - Long value representing the number of days
  - getHourInterval
```
public java.lang.Long 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
```
public void setHourInterval(java.lang.Long hourInterval_)
```
    Sets the time interval in terms of number of hours
    
    Parameters:
    
    hourInterval_ - Long value representing number of hours
  - getMinInterval
```
public java.lang.Long 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
```
public void setMinInterval(java.lang.Long minInterval_)
```
    Sets the time interval in terms of number of minutes
    
    Parameters:
    
    minInterval_ - Long value representing the number of minutes
  - getMonthInterval
```
public java.lang.Long 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
```
public void setMonthInterval(java.lang.Long monthInterval_)
```
    Sets the time interval in terms of number of months
    
    Parameters:
    
    monthInterval_ - Long value representing the number of months
  - getWeekInterval
```
public java.lang.Long 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
```
public void setWeekInterval(java.lang.Long weekInterval_)
```
    Sets the time interval in terms of number of weeks
    
    Parameters:
    
    weekInterval_ - Long value representing the number of weeks
  - getYearInterval
```
public java.lang.Long 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
```
public void setYearInterval(java.lang.Long yearInterval_)
```
    Sets the time interval in terms of number of years.
    
    Parameters:
    
    yearInterval_ - Long value representing the number of years
  - getDayIntervalExpr
```
public java.lang.String 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
```
public void setDayIntervalExpr(java.lang.String dayIntervalExpr_)
```
    Sets the time interval in terms of number of days, using an expression
    
    Parameters:
    
    dayIntervalExpr_ - Expression that should evaluate to an integer
  - getHourIntervalExpr
```
public java.lang.String 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
```
public void setHourIntervalExpr(java.lang.String hourIntervalExpr_)
```
    Sets the time interval in terms of number of hours, using an expression
    
    Parameters:
    
    hourIntervalExpr_ - Expression that should evaluate to an integer
  - getMinIntervalExpr
```
public java.lang.String 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
```
public void setMinIntervalExpr(java.lang.String minIntervalExpr_)
```
    Sets the time interval in terms of number of minutes, using an expression
    
    Parameters:
    
    minIntervalExpr_ - Expression that should evaluate to an integer
  - getMonthIntervalExpr
```
public java.lang.String 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
```
public void setMonthIntervalExpr(java.lang.String monthIntervalExpr_)
```
    Sets the time interval in terms of number of months, using an expression
    
    Parameters:
    
    monthIntervalExpr_ - Expression that should evaluate to an integer
  - getWeekIntervalExpr
```
public java.lang.String 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
```
public void setWeekIntervalExpr(java.lang.String weekIntervalExpr_)
```
    Sets the time interval in terms of number of weeks, using an expression
    
    Parameters:
    
    weekIntervalExpr_ - Expression that should evaluate to an integer
  - getYearIntervalExpr
```
public java.lang.String 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
```
public void setYearIntervalExpr(java.lang.String yearIntervalExpr_)
```
    Sets the time interval in terms of number of years, using an expression
    
    Parameters:
    
    yearIntervalExpr_ - Expression that should evaluate to an integer
  - toXML
```
public java.lang.String toXML()
```
    Returns String representation of the Interval object.
    
    Specified by:
    
    toXML in interface XMLable
    
    Returns:
    
    The XML representation of this object.
  - toXML
```
public void toXML(java.lang.StringBuilder buffer_)
```
    Description copied from interface: XMLable
    
    Appends an XML representation of this object (including all child objects) to the given buffer. Override for performance.
    
    Specified by:
    
    toXML in interface XMLable
    
    Parameters:
    
    buffer_ - StringBuffer which is populated with the String representation of the Interval object.

Class Interval

Field Summary

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

Constructor Detail

Interval

Method Detail

getDayInterval

setDayInterval

getHourInterval

setHourInterval

getMinInterval

setMinInterval

getMonthInterval

setMonthInterval

getWeekInterval

setWeekInterval

getYearInterval

setYearInterval

getDayIntervalExpr

setDayIntervalExpr

getHourIntervalExpr

setHourIntervalExpr

getMinIntervalExpr

setMinIntervalExpr

getMonthIntervalExpr

setMonthIntervalExpr

getWeekIntervalExpr

setWeekIntervalExpr

getYearIntervalExpr

setYearIntervalExpr

toXML

toXML