|
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.BurstAction
public class BurstAction
Action to generate and deliver bursting reports.
| Field Summary |
|---|
| Fields inherited from class inetsoft.sree.schedule.AbstractAction |
|---|
emailInfo, encoding, isNotifyError, notifies |
| Constructor Summary | |
|---|---|
BurstAction()
Create an empty action. |
|
BurstAction(String replet)
A burst action for the specified replet. |
|
| Method Summary | |
|---|---|
void |
clearSaveInArchive()
Remove the save in archive action. |
Object |
clone()
|
boolean |
equals(Object val)
Compares whether two schedule actions are identical. |
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 |
getBurstEmail(String user)
Get the list of emails to burst report to. |
String[] |
getBurstUsers()
Get the list of users to burst report to. |
String |
getEmailColumn()
Get email column in the query. |
String |
getEmailsFromQuery(String queryNode,
String userCol,
String mailCol,
Principal principal0)
Get mail to addresses for "Test Mail". |
SourceInfo |
getQuery()
Get the email binding query. |
String |
getRepletName()
Get the name of the replet. |
String |
getUserColumn()
Get the email user column. |
boolean |
isRegenerate()
Check if always re-generate the bursting report. |
void |
parseXML(Element action)
Parse the replet action definition from xml. |
void |
run(Principal principal0)
Execute 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 |
setBurstEmail(String user,
String email)
Set the email of a user. |
void |
setBurstUsers(String[] users)
Set the list of users to burst report to. |
void |
setEmailColumn(String emailColumn)
Set email column in the query. |
void |
setEncoding(boolean encoding)
Set encoding flag. |
void |
setQuery(SourceInfo info)
Set the email binding query. |
void |
setRegenerate(boolean regen)
Set whether to always re-generate the bursting report. |
void |
setRepletName(String replet)
Set the name of the replet to execute. |
void |
setUserColumn(String userColumn)
Set email user column. |
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 BurstAction()
public BurstAction(String replet)
| Method Detail |
|---|
public String getRepletName()
getRepletName in interface RepletSupportpublic void setRepletName(String replet)
setRepletName in interface RepletSupportpublic boolean isRegenerate()
public void setRegenerate(boolean regen)
public void setBurstUsers(String[] users)
public String[] getBurstUsers()
public void setBurstEmail(String user,
String email)
public String getBurstEmail(String user)
public SourceInfo getQuery()
public void setQuery(SourceInfo info)
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 void clearSaveInArchive()
public ArchiveRule getArchiveRule()
getArchiveRule in interface ArchiveSupportpublic void setArchiveComment(String comment)
setArchiveComment in interface ArchiveSupportpublic String getArchiveComment()
getArchiveComment in interface ArchiveSupport
public void run(Principal principal0)
throws Throwable
run in interface ScheduleActionprincipal0 - represents an entity
Throwablepublic 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 getEmailsFromQuery(String queryNode,
String userCol,
String mailCol,
Principal principal0)
throws Exception
Exceptionpublic void setUserColumn(String userColumn)
public String getUserColumn()
public void setEmailColumn(String emailColumn)
public String getEmailColumn()
|
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 | ||||||||