public interface ScheduledReport
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DAY_FRIDAY |
static java.lang.String |
DAY_MONDAY |
static java.lang.String |
DAY_SATURDAY |
static java.lang.String |
DAY_SUNDAY |
static java.lang.String |
DAY_THURSDAY |
static java.lang.String |
DAY_TUESDAY |
static java.lang.String |
DAY_WEDNESDAY |
static java.lang.String |
OCCURRENCE_DAILY |
static java.lang.String |
OCCURRENCE_MONTHLY |
static java.lang.String |
OCCURRENCE_WEEKLY |
static java.lang.String |
ORDINAL_FIRST |
static java.lang.String |
ORDINAL_FOURTH |
static java.lang.String |
ORDINAL_LAST |
static java.lang.String |
ORDINAL_SECOND |
static java.lang.String |
ORDINAL_THIRD |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Deletes the scheduled report from the registry.
|
java.lang.String |
getDay()
Get the day on which the report is scheduled.
|
int |
getDayOfMonth()
Get the day of month on which the scheduled report shall be executed.
|
java.util.Collection<java.lang.String> |
getDays()
Get all days on which the report is scheduled.
|
java.lang.String |
getDescription()
Get the description of the scheduled report.
|
java.lang.String |
getDescription(java.util.Locale locale)
Get the description of the scheduled report.
|
java.lang.String |
getExecutionDate()
Get the date on which the report was executed for the last time.
|
long |
getExecutionDateInMilliseconds()
Get the date on which the report was executed for the last time in milliseconds.
|
int |
getFrequency()
Get the frequency with which the report is executed (recurs every
|
java.lang.String |
getId()
Get the id. of the scheduled report.
|
java.lang.String |
getLocale()
Get the locale that is used when the report (template) is executed.
|
java.lang.String |
getName()
Get the name of the scheduled report.
|
java.lang.String |
getName(java.util.Locale locale)
Get the name of the scheduled report.
|
java.lang.String |
getOccurrence()
Get the occurrence of the scheduled report.
|
java.lang.String |
getOccurrenceName(java.util.Locale locale)
Get localized occurrence name.
|
java.lang.String |
getOrdinal()
Get the ordinal of a second value (day, week, month) on which the report is scheduled.
|
java.util.Collection<ReportParameter> |
getParameters()
Get the list of parameters of the scheduled report.
|
javax.xml.registry.infomodel.User |
getRecipient()
Get the recipient to whom the report will be sent.
|
java.lang.String |
getRecipientDisplayName()
Get recipient display name.
|
java.lang.String |
getRecipientId()
Get the id. of the recipient to whom the report will be sent.
|
javax.xml.registry.infomodel.RegistryObject |
getReport()
Get the report (template) to be triggered.
|
java.lang.String |
getReportId()
Get the id. of the report (template) to be triggered.
|
boolean |
renderAsPdf()
Render the report as PDF.
|
void |
save()
Saves the scheduled report to the registry.
|
void |
setDay(java.lang.String dayId)
Set the day on which the report is scheduled.
|
void |
setDayOfMonth(int dayOfMonth)
Set the day of month on which the scheduled report shall be executed.
|
void |
setDays(java.util.Collection<java.lang.String> dayIds)
Set specified list of days.
|
void |
setDescription(javax.xml.registry.infomodel.InternationalString description)
Set the description of the scheduled report.
|
void |
setDescription(java.lang.String description)
Set the description of the scheduled report.
|
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Set the description of the scheduled report.
|
void |
setExecutionDate(java.lang.String date)
Set the execution date of the scheduled report in xs:date format (YYYY-MM-DD[+|-hh:mm], e.g. 2014-12-31+01:00).
|
void |
setFrequency(int frequency)
Set the frequency with which the report is executed (recurs every
|
void |
setLocale(java.lang.String localeName)
Set the locale that is used when the report (template) is executed.
|
void |
setName(javax.xml.registry.infomodel.InternationalString name)
Set the name of the scheduled report.
|
void |
setName(java.lang.String name)
Set the name of the scheduled report.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Set the name of the scheduled report.
|
void |
setOccurrence(java.lang.String occurrenceId)
Set the occurrence of the scheduled report.
|
void |
setOrdinal(java.lang.String ordinalId)
Set the ordinal of a second value (day, week, month) on which the report is scheduled.
|
void |
setParameters(java.util.Collection<ReportParameter> parameters)
Set the list of parameters of the scheduled report.
|
void |
setRecipient(javax.xml.registry.infomodel.User recipient)
Set the recipient to whom the report will be sent.
|
void |
setRecipientId(java.lang.String recipientId)
Set the id. of the recipient to whom the report will be sent.
|
void |
setRenderAsPdf(boolean renderAsPdf)
Set the rendering format of the report.
|
void |
setReport(javax.xml.registry.infomodel.RegistryObject report)
Set the report (template) to be triggered.
|
void |
setReportId(java.lang.String reportId)
Set the id. of the report (template) to be triggered.
|
void |
setSubmittingOrganization(javax.xml.registry.infomodel.Organization organization)
Set default submitting organization.
|
void |
setSubmittingOrganization(java.lang.String organizationId)
Set default submitting organization.
|
static final java.lang.String OCCURRENCE_DAILY
static final java.lang.String OCCURRENCE_WEEKLY
static final java.lang.String OCCURRENCE_MONTHLY
static final java.lang.String DAY_MONDAY
static final java.lang.String DAY_TUESDAY
static final java.lang.String DAY_WEDNESDAY
static final java.lang.String DAY_THURSDAY
static final java.lang.String DAY_FRIDAY
static final java.lang.String DAY_SATURDAY
static final java.lang.String DAY_SUNDAY
static final java.lang.String ORDINAL_FIRST
static final java.lang.String ORDINAL_SECOND
static final java.lang.String ORDINAL_THIRD
static final java.lang.String ORDINAL_FOURTH
static final java.lang.String ORDINAL_LAST
java.lang.String getId() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.lang.String getName() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.lang.String getName(java.util.Locale locale) throws javax.xml.registry.JAXRException
locale
- The locale in which the name to be retrieved.javax.xml.registry.JAXRException
void setName(java.lang.String name) throws javax.xml.registry.JAXRException
name
- The name of the scheduled report.javax.xml.registry.JAXRException
void setName(java.lang.String name, java.util.Locale locale) throws javax.xml.registry.JAXRException
name
- The name of the scheduled report.locale
- The locale in which the name is stored.javax.xml.registry.JAXRException
void setName(javax.xml.registry.infomodel.InternationalString name) throws javax.xml.registry.JAXRException
name
- The name of the scheduled report.javax.xml.registry.JAXRException
java.lang.String getDescription() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.lang.String getDescription(java.util.Locale locale) throws javax.xml.registry.JAXRException
locale
- The locale in which the description to be retrieved.javax.xml.registry.JAXRException
void setDescription(java.lang.String description) throws javax.xml.registry.JAXRException
description
- The description of the scheduled report.javax.xml.registry.JAXRException
void setDescription(java.lang.String description, java.util.Locale locale) throws javax.xml.registry.JAXRException
description
- The description of the scheduled report.locale
- The locale in which the description is stored.javax.xml.registry.JAXRException
void setDescription(javax.xml.registry.infomodel.InternationalString description) throws javax.xml.registry.JAXRException
description
- The description of the scheduled report.javax.xml.registry.JAXRException
java.lang.String getOccurrence() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setOccurrence(java.lang.String occurrenceId) throws javax.xml.registry.JAXRException
occurrenceId
- Id. indicating how often the report is scheduled. The id. must have one of the following predefined values:
javax.xml.registry.JAXRException
java.lang.String getOccurrenceName(java.util.Locale locale) throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.lang.String getOrdinal() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setOrdinal(java.lang.String ordinalId) throws javax.xml.registry.JAXRException
ordinalId
- The ordinal id., which must have one of the following predefined values:
javax.xml.registry.JAXRException
java.lang.String getDay() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.util.Collection<java.lang.String> getDays() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setDay(java.lang.String dayId) throws javax.xml.registry.JAXRException
dayId
- The day id., which must have one of the following predefined values:
javax.xml.registry.JAXRException
void setDays(java.util.Collection<java.lang.String> dayIds) throws javax.xml.registry.JAXRException
dayIds
- list of day ids, which will be part of the following values:
javax.xml.registry.JAXRException
java.lang.String getRecipientId() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setRecipientId(java.lang.String recipientId) throws javax.xml.registry.JAXRException
recipientId
- The id. of the recipient to whom the report will be sent.javax.xml.registry.JAXRException
javax.xml.registry.infomodel.User getRecipient() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setRecipient(javax.xml.registry.infomodel.User recipient) throws javax.xml.registry.JAXRException
recipient
- The recipient to whom the report will be sent.javax.xml.registry.JAXRException
java.lang.String getRecipientDisplayName() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.lang.String getReportId() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setReportId(java.lang.String reportId) throws javax.xml.registry.JAXRException
reportId
- The id. of the report (template) to be triggered.javax.xml.registry.JAXRException
javax.xml.registry.infomodel.RegistryObject getReport() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setReport(javax.xml.registry.infomodel.RegistryObject report) throws javax.xml.registry.JAXRException
report
- The report (template) to be triggered.javax.xml.registry.JAXRException
java.lang.String getLocale() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setLocale(java.lang.String localeName) throws javax.xml.registry.JAXRException
localeName
- language and country code according to RFC 4646 and IETF BCP 47 (e.g. "en-US").javax.xml.registry.JAXRException
int getFrequency() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setFrequency(int frequency) throws javax.xml.registry.JAXRException
frequency
- The frequency of the scheduled report.javax.xml.registry.JAXRException
java.lang.String getExecutionDate() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setExecutionDate(java.lang.String date) throws javax.xml.registry.JAXRException
date
- The execution date of the scheduled report.javax.xml.registry.JAXRException
long getExecutionDateInMilliseconds() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
int getDayOfMonth() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setDayOfMonth(int dayOfMonth) throws javax.xml.registry.JAXRException
dayOfMonth
- The day of month on which the scheduled report shall be executed.javax.xml.registry.JAXRException
boolean renderAsPdf() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setRenderAsPdf(boolean renderAsPdf) throws javax.xml.registry.JAXRException
renderAsPdf
- True if rendered as PDF, False if rendered as PDF.javax.xml.registry.JAXRException
java.util.Collection<ReportParameter> getParameters() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setParameters(java.util.Collection<ReportParameter> parameters) throws javax.xml.registry.JAXRException
parameters
- The list of parameters of the scheduled report.javax.xml.registry.JAXRException
void setSubmittingOrganization(javax.xml.registry.infomodel.Organization organization) throws javax.xml.registry.JAXRException
organization
- The default submitting organization.javax.xml.registry.JAXRException
void setSubmittingOrganization(java.lang.String organizationId) throws javax.xml.registry.JAXRException
organizationId
- The id. of the default submitting organization.javax.xml.registry.JAXRException
void save() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void delete() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException