Style Intelligence v12.0

inetsoft.sree.schedule
Class BurstAction

java.lang.Object
  extended by inetsoft.sree.schedule.AbstractAction
      extended by inetsoft.sree.schedule.BurstAction
All Implemented Interfaces:
inetsoft.sree.internal.HttpXMLSerializable, ArchiveSupport, CancelableAction, EmailSupport, RepletSupport, ScheduleAction, inetsoft.util.XMLSerializable, Serializable, Cloneable

public class BurstAction
extends AbstractAction
implements ScheduleAction, RepletSupport, ArchiveSupport

Action to generate and deliver bursting reports.

See Also:
Serialized Form

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

BurstAction

public BurstAction()
Create an empty action.


BurstAction

public BurstAction(String replet)
A burst action for the specified replet.

Method Detail

getRepletName

public String getRepletName()
Get the name of the replet.

Specified by:
getRepletName in interface RepletSupport

setRepletName

public void setRepletName(String replet)
Set the name of the replet to execute.

Specified by:
setRepletName in interface RepletSupport

isRegenerate

public boolean isRegenerate()
Check if always re-generate the bursting report.


setRegenerate

public void setRegenerate(boolean regen)
Set whether to always re-generate the bursting report.


setBurstUsers

public void setBurstUsers(String[] users)
Set the list of users to burst report to.


getBurstUsers

public String[] getBurstUsers()
Get the list of users to burst report to.


setBurstEmail

public void setBurstEmail(String user,
                          String email)
Set the email of a user.


getBurstEmail

public String getBurstEmail(String user)
Get the list of emails to burst report to.


getQuery

public SourceInfo getQuery()
Get the email binding query.

Returns:
SourceInfo.

setQuery

public void setQuery(SourceInfo info)
Set the email binding query.


setArchivePath

public void setArchivePath(String path)
Set the path in the archive to save a report.

Specified by:
setArchivePath in interface ArchiveSupport

getArchivePath

public String getArchivePath()
Get the path in the archive to save a report.

Specified by:
getArchivePath in interface ArchiveSupport

setArchiveFormat

public void setArchiveFormat(int format)
Set the format to save the report in archive.

Specified by:
setArchiveFormat in interface ArchiveSupport

getArchiveFormat

public int getArchiveFormat()
Get the format to save the report in archive.

Specified by:
getArchiveFormat in interface ArchiveSupport

setArchivePermission

public void setArchivePermission(Permission perm)
Set the permission in the archive to save a report.

Specified by:
setArchivePermission in interface ArchiveSupport

getArchivePermission

public Permission getArchivePermission()
Get the saved copy's permission.

Specified by:
getArchivePermission in interface ArchiveSupport

setArchiveRule

public void setArchiveRule(ArchiveRule rule)
Set the archive rule of the saved report.

Specified by:
setArchiveRule in interface ArchiveSupport

clearSaveInArchive

public void clearSaveInArchive()
Remove the save in archive action.


getArchiveRule

public ArchiveRule getArchiveRule()
Get the archive rule of the saved report.

Specified by:
getArchiveRule in interface ArchiveSupport

setArchiveComment

public void setArchiveComment(String comment)
Set the comment associated with this report.

Specified by:
setArchiveComment in interface ArchiveSupport

getArchiveComment

public String getArchiveComment()
Get the comment associated with this report.

Specified by:
getArchiveComment in interface ArchiveSupport

run

public void run(Principal principal0)
         throws Throwable
Execute this action.

Specified by:
run in interface ScheduleAction
Parameters:
principal0 - represents an entity
Throws:
Throwable

toString

public String toString()
Overrides:
toString in class Object

clone

public Object clone()
Overrides:
clone in class Object

writeXML

public void writeXML(PrintWriter writer)
Write itself to a xml file

Specified by:
writeXML in interface inetsoft.util.XMLSerializable

parseXML

public void parseXML(Element action)
              throws Exception
Parse the replet action definition from xml.

Specified by:
parseXML in interface inetsoft.util.XMLSerializable
Throws:
Exception

equals

public boolean equals(Object val)
Compares whether two schedule actions are identical.

Overrides:
equals in class Object

setEncoding

public void setEncoding(boolean encoding)
Set encoding flag.

Specified by:
setEncoding in interface inetsoft.sree.internal.HttpXMLSerializable
Overrides:
setEncoding in class AbstractAction
Parameters:
encoding - true to encode.

getEmailsFromQuery

public String getEmailsFromQuery(String queryNode,
                                 String userCol,
                                 String mailCol,
                                 Principal principal0)
                          throws Exception
Get mail to addresses for "Test Mail".

Throws:
Exception

setUserColumn

public void setUserColumn(String userColumn)
Set email user column.


getUserColumn

public String getUserColumn()
Get the email user column.


setEmailColumn

public void setEmailColumn(String emailColumn)
Set email column in the query.


getEmailColumn

public String getEmailColumn()
Get email column in the query.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.