public class ReportSchedule extends Object implements Serializable, org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.HashCode, org.jvnet.jaxb2_commons.lang.ToString
This element provides scheduling mechanism while creating a report template. User should specify API in-built frequency. DayOfMonth or day of week should be provided
when specific day of month or week is selected respectively. Else it is ignored. A end date can be specified to stop recurrence of report generation.
For say user provides:
"schedule": {
"frequency": "SPECIFIC_DAY_OF_MONTH",
"dayOfTheMonth": "1"
"endDate": ""2030-10-30"
}
This means the report will be triggered on 1st of every month till 30th of October 2030.
Java class for ReportSchedule complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="ReportSchedule"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element name="frequency" type="{http://service.aeris.com/reports/v1/basetype}Frequency"/> <element name="dayOfTheMonth" type="{http://service.aeris.com/reports/v1/basetype}DayOfMonth" minOccurs="0"/> <element name="endDate" type="{http://service.aeris.com/reports/v1/basetype}EndDate" minOccurs="0"/> <element name="dayOfTheWeek" type="{http://service.aeris.com/reports/v1/basetype}DayOfWeek" minOccurs="0"/> </sequence> </restriction> </complexContent> </complexType>
Modifier and Type | Field and Description |
---|---|
protected Integer |
dayOfTheMonth |
protected DayOfWeek |
dayOfTheWeek |
protected Calendar |
endDate |
protected Frequency |
frequency |
Constructor and Description |
---|
ReportSchedule() |
Modifier and Type | Method and Description |
---|---|
StringBuilder |
append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
StringBuilder buffer,
org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy) |
StringBuilder |
appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
StringBuilder buffer,
org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy) |
boolean |
equals(Object object) |
boolean |
equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
Object object,
org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy) |
Integer |
getDayOfTheMonth()
Gets the value of the dayOfTheMonth property.
|
DayOfWeek |
getDayOfTheWeek()
Gets the value of the dayOfTheWeek property.
|
Calendar |
getEndDate()
Gets the value of the endDate property.
|
Frequency |
getFrequency()
Gets the value of the frequency property.
|
int |
hashCode() |
int |
hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
org.jvnet.jaxb2_commons.lang.HashCodeStrategy strategy) |
void |
setDayOfTheMonth(Integer value)
Sets the value of the dayOfTheMonth property.
|
void |
setDayOfTheWeek(DayOfWeek value)
Sets the value of the dayOfTheWeek property.
|
void |
setEndDate(Calendar value)
Sets the value of the endDate property.
|
void |
setFrequency(Frequency value)
Sets the value of the frequency property.
|
String |
toString() |
@NotNull protected Frequency frequency
@Digits(integer=2, fraction=0) protected Integer dayOfTheMonth
protected Calendar endDate
protected DayOfWeek dayOfTheWeek
public Frequency getFrequency()
Frequency
public void setFrequency(Frequency value)
value
- allowed object is
Frequency
public Integer getDayOfTheMonth()
Integer
public void setDayOfTheMonth(Integer value)
value
- allowed object is
Integer
public Calendar getEndDate()
String
public void setEndDate(Calendar value)
value
- allowed object is
String
public DayOfWeek getDayOfTheWeek()
DayOfWeek
public void setDayOfTheWeek(DayOfWeek value)
value
- allowed object is
DayOfWeek
public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)
equals
in interface org.jvnet.jaxb2_commons.lang.Equals
public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)
append
in interface org.jvnet.jaxb2_commons.lang.ToString
public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)
appendFields
in interface org.jvnet.jaxb2_commons.lang.ToString
public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy strategy)
hashCode
in interface org.jvnet.jaxb2_commons.lang.HashCode
Copyright © 2023. All rights reserved.