Style Intelligence v12.0

inetsoft.sree.schedule
Class AbstractAction

java.lang.Object
  extended by inetsoft.sree.schedule.AbstractAction
All Implemented Interfaces:
inetsoft.sree.internal.HttpXMLSerializable, CancelableAction, EmailSupport, ScheduleAction, inetsoft.util.XMLSerializable, Serializable, Cloneable
Direct Known Subclasses:
BurstAction, RepletAction, ViewsheetAction

public abstract class AbstractAction
extends Object
implements Cloneable, EmailSupport, inetsoft.sree.internal.HttpXMLSerializable, CancelableAction

This is the base class for action.

See Also:
Serialized Form

Field Summary
protected  inetsoft.sree.schedule.EmailInfo emailInfo
           
protected  boolean encoding
           
protected  boolean isNotifyError
           
protected  String notifies
           
 
Constructor Summary
AbstractAction()
           
 
Method Summary
 String byteDecode(String encString)
          Convert the encoded string to the original unencoded string.
 String byteEncode(String source)
          Encode non-ascii characters to unicode enclosed in '[]'.
 void cancel()
          Cancel the action.
 String getAttachmentName()
          Get email attachmentName.
 String getEmails()
          Get all emails to send the report.
protected  String getEmails(String emailStr)
          Get notification emails.
 String getFileFormat()
          Get the email file format.
 String getFrom()
          Get the from text of the email header.
 String getMessage()
          Get the email text message.
 String getNotifications()
          Get all notification emails.
 String getPassword()
          Get the encrypt zip file password.
 String getSubject()
          Get the email subject.
protected  boolean isCanceled()
          Cancel the action.
 boolean isCompressFile()
          Check if the exported file needs to be zipped up.
 boolean isEncoding()
          Check if this object should encoded when writing.
 boolean isNotifyError()
          Notify only if failed.
 void notify(String email)
          Add a notification email to notify when this action is completed.
 void setAttachmentName(String attachmentName)
          Set email attachmentName.
 void setCompressFile(boolean compress)
          Set the flag indicating whether or not the exported file is to be zipped up before it is delivered.
 void setEmails(String emails)
          Set the emails to send the report notification.
 void setEncoding(boolean encoding)
          Set encoding flag.
 void setFileFormat(String format)
          Set the email file format.
 void setFrom(String from)
          Set the from text of the email that is sent by this replet action.
 void setMessage(String msg)
          Set email message.
 void setNotifications(String notifies)
          Set the notification list.
 void setNotifyError(boolean isNotifyError)
          Set the flag indicating whether or not send a success email.
 void setPassword(String password)
          Set the encrypt zip file password.
 void setSubject(String subject)
          Set the email subject.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface inetsoft.sree.schedule.ScheduleAction
run
 
Methods inherited from interface inetsoft.util.XMLSerializable
parseXML, writeXML
 

Field Detail

encoding

protected transient boolean encoding

isNotifyError

protected boolean isNotifyError

notifies

protected String notifies

emailInfo

protected inetsoft.sree.schedule.EmailInfo emailInfo
Constructor Detail

AbstractAction

public AbstractAction()
Method Detail

notify

public void notify(String email)
Add a notification email to notify when this action is completed.

Parameters:
email - comma separated email list.

setEmails

public void setEmails(String emails)
Set the emails to send the report notification.

Specified by:
setEmails in interface EmailSupport
Parameters:
emails - comma separated email list.

getEmails

public String getEmails()
Get all emails to send the report.

Specified by:
getEmails in interface EmailSupport

setNotifications

public void setNotifications(String notifies)
Set the notification list.

Specified by:
setNotifications in interface EmailSupport

getNotifications

public String getNotifications()
Get all notification emails.

Specified by:
getNotifications in interface EmailSupport

setFrom

public void setFrom(String from)
Set the from text of the email that is sent by this replet action.

Specified by:
setFrom in interface EmailSupport
Parameters:
from - the from text of the email header.

getFrom

public String getFrom()
Get the from text of the email header.

Specified by:
getFrom in interface EmailSupport
Returns:
from text of the email header.

setMessage

public void setMessage(String msg)
Set email message.

Specified by:
setMessage in interface EmailSupport

getMessage

public String getMessage()
Get the email text message.

Specified by:
getMessage in interface EmailSupport

setSubject

public void setSubject(String subject)
Set the email subject.

Specified by:
setSubject in interface EmailSupport

getSubject

public String getSubject()
Get the email subject.

Specified by:
getSubject in interface EmailSupport

setFileFormat

public void setFileFormat(String format)
Set the email file format.

Specified by:
setFileFormat in interface EmailSupport

getFileFormat

public String getFileFormat()
Get the email file format.

Specified by:
getFileFormat in interface EmailSupport

setCompressFile

public void setCompressFile(boolean compress)
Set the flag indicating whether or not the exported file is to be zipped up before it is delivered.

Specified by:
setCompressFile in interface EmailSupport

isCompressFile

public boolean isCompressFile()
Check if the exported file needs to be zipped up.

Specified by:
isCompressFile in interface EmailSupport

setAttachmentName

public void setAttachmentName(String attachmentName)
Set email attachmentName.


getAttachmentName

public String getAttachmentName()
Get email attachmentName.


setPassword

public void setPassword(String password)
Set the encrypt zip file password.

Parameters:
password - the encrypt file password.

getPassword

public String getPassword()
Get the encrypt zip file password.

Returns:
the encrypt file password.

setNotifyError

public void setNotifyError(boolean isNotifyError)
Set the flag indicating whether or not send a success email.

Parameters:
isNotifyError - notify only if failed.

isNotifyError

public boolean isNotifyError()
Notify only if failed.


byteEncode

public String byteEncode(String source)
Encode non-ascii characters to unicode enclosed in '[]'.

Specified by:
byteEncode in interface inetsoft.sree.internal.HttpXMLSerializable
Parameters:
source - source string.
Returns:
encoded string.

byteDecode

public String byteDecode(String encString)
Convert the encoded string to the original unencoded string.

Specified by:
byteDecode in interface inetsoft.sree.internal.HttpXMLSerializable
Parameters:
encString - a string encoded using the byteEncode method.
Returns:
original string.

isEncoding

public boolean isEncoding()
Check if this object should encoded when writing.

Specified by:
isEncoding in interface inetsoft.sree.internal.HttpXMLSerializable
Returns:
true if should encoded, false otherwise.

setEncoding

public void setEncoding(boolean encoding)
Set encoding flag.

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

cancel

public void cancel()
Cancel the action.

Specified by:
cancel in interface CancelableAction

isCanceled

protected boolean isCanceled()
Cancel the action.


getEmails

protected String getEmails(String emailStr)
Get notification emails.


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