|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.sree.schedule.AbstractAction
inetsoft.sree.schedule.RepletAction
public class RepletAction
A schedule action to run a report (replet). The action could save the report in a PDF file, deliver it through email, save the output in the report archive, or print it to a printer.
| Nested Class Summary | |
|---|---|
class |
RepletAction.ScheduleActionListener
Schedule action listener, use to cancel the current task. |
| Field Summary |
|---|
| Fields inherited from class inetsoft.sree.schedule.AbstractAction |
|---|
emailInfo, encoding, isNotifyError, notifies |
| Constructor Summary | |
|---|---|
RepletAction()
Create an empty action. |
|
RepletAction(String replet,
RepletRequest request)
A replet action for the specified replet. |
|
| Method Summary | |
|---|---|
void |
clearSaveInArchive()
Remove the save in archive action. |
Object |
clone()
|
boolean |
equals(Object val)
|
ScheduleAlert[] |
getAlerts()
Gets the alert conditions for this action. |
String |
getArchiveComment()
Get the comment associated with this report. |
int |
getArchiveFormat()
Get the format to save the report in archive. |
String |
getArchivePath()
Get the path in the archive to save a report. |
Permission |
getArchivePermission()
Get the saved copy's permission. |
ArchiveRule |
getArchiveRule()
Get the archive rule of the saved report. |
String |
getCSV()
Deprecated. use getFilePath(Builder.CSV) instead. |
String |
getExcel()
Deprecated. use getFilePath(Builder.EXCEL) instead. |
String |
getExcelData()
Deprecated. use getFilePath(Builder.EXCEL_DATA) instead. |
String |
getExcelLayout()
Deprecated. use getFilePath(Builder.EXCEL_SHEET) instead. |
String |
getFilePath(int format)
Gets the file path at which the file will be saved for a particular format. |
String |
getHTML()
Deprecated. use getFilePath(Builder.HTML_BUNDLE) instead. |
String |
getHTMLNoPages()
Deprecated. use getFilePath(Builder.HTML_BUNDLE_NO_PAGINATION) instead. |
String |
getLocale()
Get the locale used by this replet action. |
String |
getPDF()
Deprecated. use getFilePath(Builder.PDF) instead. |
String |
getPPT()
Deprecated. use getFilePath(Builder.POWERPOINT) instead. |
String |
getPrinterList()
Get printers as a comma separated list |
String[] |
getPrinters()
Get all printers. |
String |
getRepletName()
Get the name of the replet. |
RepletRequest |
getRepletRequest()
Get the request used to generate the report. |
String |
getRTF()
Deprecated. use getFilePath(Builder.RTF) instead. |
String |
getRTFLayout()
Deprecated. use getFilePath(Builder.RTF_LAYOUT) instead. |
int[] |
getSaveFormats()
Gets a list of all the formats in which the report will be saved. |
String |
getScheduleEmails(RepletEngine engine,
Object id)
Get the schedule info. |
String |
getSVG()
Deprecated. use getFilePath(Builder.SVG) instead. |
String |
getTxt()
Deprecated. use getFilePath(Builder.TEXT) instead. |
String |
getXML()
Deprecated. use getFilePath(Builder.XML) instead. |
boolean |
isSaveToDisk()
Return whether the action exports to disk. |
void |
mailTo(String email,
String from,
String fmt,
boolean compress,
String subject,
String msg)
Add one or more emails to send the output of the replet to. |
void |
mailTo(String email,
String from,
String fmt,
boolean compress,
String subject,
String msg,
String attachmentName)
Add one or more emails to send the output of the replet to. |
void |
mailTo(String email,
String from,
String fmt,
String msg)
Add one or more emails to send the output of the replet to. |
void |
mailTo(String email,
String from,
String fmt,
String subject,
String msg)
Add one or more emails to send the output of the replet to. |
void |
parseXML(Element action)
Parse the replet action definition from xml. |
protected Object |
prepareReplet(Principal principal,
RepletRepository repository)
|
void |
run(Principal principal)
Execute this action. |
Object |
runRepletAction(Principal principal,
RepletRepository repository)
Executes this action. |
void |
saveCSV(String csv)
Deprecated. use setFilePath(Builder.CSV, path) instead. |
void |
saveExcel(String excel)
Deprecated. use setFilePath(Builder.EXCEL, path) instead. |
void |
saveExcelData(String excel)
Deprecated. use setFilePath(Builder.EXCEL_DATA, path) instead. |
void |
saveExcelLayout(String excel)
Deprecated. use setFilePath(Builder.EXCEL_SHEET, path) instead. |
void |
saveHTML(String html)
Deprecated. use setFilePath(Builder.HTML_BUNDLE, path) instead. |
void |
saveHTMLNoPages(String html)
Deprecated. use setFilePath(Builder.HTML_BUNDLE_NO_PAGINATION, path) instead. |
void |
saveInArchive(String path,
int fmt,
Permission perm,
ArchiveRule rule,
String comment)
Save the generated report in report archive. |
void |
savePDF(String pdf)
Deprecated. use setFilePath(Builder.PDF, path) instead. |
void |
savePPT(String ppt)
Deprecated. use setFilePath(Builder.POWERPOINT, path) instead. |
void |
saveRTF(String rtf)
Deprecated. use setFilePath(Builder.RTF, path) instead. |
void |
saveRTFLayout(String rtf)
Deprecated. use setFilePath(Builder.RTF_LAYOUT, path) instead. |
void |
saveSVG(String svg)
Deprecated. use setFilePath(Builder.SVG, path) instead. |
void |
saveTxt(String txt)
Deprecated. use setFilePath(Builder.TEXT, path) instead. |
void |
saveXML(String xml)
Deprecated. use setFilePath(Builder.XML, path) instead. |
void |
setAlerts(ScheduleAlert[] alerts)
Sets the alert conditions for this action. |
void |
setArchiveComment(String comment)
Set the comment associated with this report. |
void |
setArchiveFormat(int format)
Set the format to save the report in archive. |
void |
setArchivePath(String path)
Set the path in the archive to save a report. |
void |
setArchivePermission(Permission perm)
Set the permission in the archive to save a report. |
void |
setArchiveRule(ArchiveRule rule)
Set the archive rule of the saved report. |
void |
setEncoding(boolean encoding)
Set encoding flag. |
void |
setFilePath(int format,
String path)
Sets the file path to which to save the file in a particular format. |
void |
setLocale(String locale)
Set the locale to be used by this replet action. |
void |
setPrinters(String[] printers)
Add a printer to print the output of the replet. |
void |
setRepletName(String replet)
Set the name of the replet to execute. |
void |
setRepletRequest(RepletRequest req)
Set the request used to generate the report. |
String |
toString()
|
void |
writeXML(PrintWriter writer)
Write itself to a xml file |
| Methods inherited from class inetsoft.sree.schedule.AbstractAction |
|---|
byteDecode, byteEncode, cancel, getAttachmentName, getEmails, getEmails, getFileFormat, getFrom, getMessage, getNotifications, getPassword, getSubject, isCanceled, isCompressFile, isEncoding, isNotifyError, notify, setAttachmentName, setCompressFile, setEmails, setFileFormat, setFrom, setMessage, setNotifications, setNotifyError, setPassword, setSubject |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public RepletAction()
public RepletAction(String replet,
RepletRequest request)
| Method Detail |
|---|
public void setPrinters(String[] printers)
printers - printer name.
public void mailTo(String email,
String from,
String fmt,
String msg)
email - comma separated email list.from - the from text of the email header.fmt - file format, "PDF" or one of the format names defined
in Builder.msg - email text message.
public void mailTo(String email,
String from,
String fmt,
String subject,
String msg)
email - comma separated email list.from - the from text of the email header.fmt - file format, "PDF" or one of the format names defined
in Builder.subject - email subject line.msg - email text message.
public void mailTo(String email,
String from,
String fmt,
boolean compress,
String subject,
String msg)
email - comma separated email list.from - the from text of the email header.fmt - file format, "PDF" or one of the format names defined
in Builder.compress - flag indicating whether or not the exported
file is to be compressed.subject - email subject line.msg - email text message.
public void mailTo(String email,
String from,
String fmt,
boolean compress,
String subject,
String msg,
String attachmentName)
email - comma separated email list.from - the from text of the email header.fmt - file format, "PDF" or one of the format names defined
in Builder.compress - flag indicating whether or not the exported
file is to be compressed.subject - email subject line.msg - email text message.attachmentName - email attachment's name.
public void saveInArchive(String path,
int fmt,
Permission perm,
ArchiveRule rule,
String comment)
path - report path in the archive.fmt - one of the format constants defined in Builder or
RepletRepository.perm - saved report access permission.rule - archive rule.comment - for the saved report.public void clearSaveInArchive()
public String getRepletName()
getRepletName in interface RepletSupportpublic void setRepletName(String replet)
setRepletName in interface RepletSupportpublic RepletRequest getRepletRequest()
public void setRepletRequest(RepletRequest req)
public String getLocale()
public void setLocale(String locale)
locale - to be used by this replet action.public String[] getPrinters()
public String getPrinterList()
public boolean isSaveToDisk()
public void setArchivePath(String path)
setArchivePath in interface ArchiveSupportpublic String getArchivePath()
getArchivePath in interface ArchiveSupportpublic void setArchiveFormat(int format)
setArchiveFormat in interface ArchiveSupportpublic int getArchiveFormat()
getArchiveFormat in interface ArchiveSupportpublic void setArchivePermission(Permission perm)
setArchivePermission in interface ArchiveSupportpublic Permission getArchivePermission()
getArchivePermission in interface ArchiveSupportpublic void setArchiveRule(ArchiveRule rule)
setArchiveRule in interface ArchiveSupportpublic ArchiveRule getArchiveRule()
getArchiveRule in interface ArchiveSupportpublic void setArchiveComment(String comment)
setArchiveComment in interface ArchiveSupportpublic String getArchiveComment()
getArchiveComment in interface ArchiveSupportpublic void saveXML(String xml)
xml - full path of the file.public String getXML()
null if the report should
not be saved to XML.public void savePDF(String pdf)
pdf - full path of the file.public String getPDF()
null if the report should
not be saved to PDF.public void saveHTML(String html)
html - full path of the file.public String getHTML()
null if the report
should not be saved to HTML.public void saveHTMLNoPages(String html)
html - full path of the file.public String getHTMLNoPages()
null if the report
should not be saved to HTML.public void saveExcel(String excel)
excel - the path to the Excel file to save.public String getExcel()
null if the report
should not be saved to Excel.public void saveExcelLayout(String excel)
excel - the path to the Excel Layout file to save.public String getExcelLayout()
null if the
report should not be saved to Excel Layout.public void saveExcelData(String excel)
excel - the path to the Excel Data file to save.public String getExcelData()
null if the report
should not be saved to Excel Data.public void saveRTF(String rtf)
rtf - the path to the RTF file to save.public String getRTF()
null if the report should
not be saved to RTF.public void saveRTFLayout(String rtf)
rtf - the path to the RTF Layout file to save.public String getRTFLayout()
null if the report
should not be saved to RTF Layout.public void saveSVG(String svg)
svg - the path to the SVG file to save.public String getPPT()
null if the report should
not be saved to ppt.public void savePPT(String ppt)
ppt - the path to the ppt file to save.public String getSVG()
null if the report should
not be saved to SVG.public void saveCSV(String csv)
csv - the path to the CSV file to save.public String getCSV()
null if the report should
not be saved to CSV.public void saveTxt(String txt)
txt - the path to the Txt file to save.public String getTxt()
null if the report should
not be saved to Txt.
public void setFilePath(int format,
String path)
format - the format in which to save. Must be a format supported by
inetsoft.report.io.Builder.path - the file path.public String getFilePath(int format)
format - the format for which to get the file path. Must be a format
type supported by inetsoft.report.io.Builder.
null if the file will not be saved
in the specified format.public int[] getSaveFormats()
public ScheduleAlert[] getAlerts()
public void setAlerts(ScheduleAlert[] alerts)
alerts - the alert conditions.
public void run(Principal principal)
throws Throwable
run in interface ScheduleActionprincipal - represents an entity
Throwable
protected Object prepareReplet(Principal principal,
RepletRepository repository)
throws Throwable
Throwable
public Object runRepletAction(Principal principal,
RepletRepository repository)
throws Throwable
principal - the user that is executing the action.repository - the replet engine.
Throwable - if an error occurs while executing this action.public String toString()
toString in class Objectpublic Object clone()
clone in class Objectpublic void writeXML(PrintWriter writer)
writeXML in interface inetsoft.util.XMLSerializable
public void parseXML(Element action)
throws Exception
parseXML in interface inetsoft.util.XMLSerializableExceptionpublic boolean equals(Object val)
equals in class Objectpublic void setEncoding(boolean encoding)
setEncoding in interface inetsoft.sree.internal.HttpXMLSerializablesetEncoding in class AbstractActionencoding - true to encode.
public String getScheduleEmails(RepletEngine engine,
Object id)
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||