Style Intelligence v12.0

inetsoft.sree.schedule
Class ViewsheetAction

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

public class ViewsheetAction
extends AbstractAction

A schedule action to run a viewsheet. The action could save the viewsheet in a PDF file, deliver it through email.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class inetsoft.sree.schedule.AbstractAction
emailInfo, encoding, isNotifyError, notifies
 
Constructor Summary
ViewsheetAction()
          Create an empty action.
ViewsheetAction(String viewsheet, RepletRequest request)
          A viewsheet action for the specified viewsheet.
 
Method Summary
 void clearBookmark()
           
 Object clone()
           
 boolean equals(Object val)
          Compares whether two schedule actions are identical.
 ScheduleAlert[] getAlerts()
          Gets the alert conditions for this action.
 String getBookmark()
           
 String getBookmarkUser()
           
protected  String getFileExtend(int format)
          Get the file extend.
protected  int getFileType()
           
 inetsoft.util.ItemMap getParams()
          Get the parameters used to generate the viewsheet.
 String getScheduleEmails(inetsoft.report.composition.execution.ViewsheetSandbox box)
           
protected  String getViewsheet()
           
 String getViewSheetName()
          Get the viewsheet name of the action.
 RepletRequest getViewsheetRequest()
          Get the request used to generate the viewsheet.
protected  inetsoft.report.io.viewsheet.VSExporter getVSExporter(int type, OutputStream out)
           
 boolean isMatchLayout()
          If match the layout.
 void parseXML(Element action)
          Parse the replet action definition from xml.
protected  String prepareViewsheet(Principal principal)
           
 void run(Principal principal)
          Execute this action.
 String runViewsheetAction(Principal principal)
           
 void setAlerts(ScheduleAlert[] alerts)
          Sets the alert conditions for this action.
 void setMatchLayout(boolean matched)
          Set the match lay out.
 void setViewSheetName(String name)
          Set the viewsheet name of the action.
 void setViewsheetRequest(RepletRequest req)
          Set the request used to generate the viewsheet.
 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, setEncoding, setFileFormat, setFrom, setMessage, setNotifications, setNotifyError, setPassword, setSubject
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ViewsheetAction

public ViewsheetAction()
Create an empty action.


ViewsheetAction

public ViewsheetAction(String viewsheet,
                       RepletRequest request)
A viewsheet action for the specified viewsheet. When this action is executed, the viewsheet is created and the result is mailed.

Method Detail

getViewsheetRequest

public RepletRequest getViewsheetRequest()
Get the request used to generate the viewsheet.


setViewsheetRequest

public void setViewsheetRequest(RepletRequest req)
Set the request used to generate the viewsheet.


getViewSheetName

public String getViewSheetName()
Get the viewsheet name of the action.


setViewSheetName

public void setViewSheetName(String name)
Set the viewsheet name of the action.


clearBookmark

public void clearBookmark()

getParams

public inetsoft.util.ItemMap getParams()
Get the parameters used to generate the viewsheet.


parseXML

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

Throws:
Exception

writeXML

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


equals

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

Overrides:
equals in class Object

toString

public String toString()
Overrides:
toString in class Object

clone

public Object clone()
Overrides:
clone in class Object

run

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

Parameters:
principal - represents an entity
Throws:
Throwable

prepareViewsheet

protected String prepareViewsheet(Principal principal)
                           throws Throwable
Throws:
Throwable

runViewsheetAction

public String runViewsheetAction(Principal principal)
                          throws Throwable
Throws:
Throwable

getFileType

protected int getFileType()

getVSExporter

protected inetsoft.report.io.viewsheet.VSExporter getVSExporter(int type,
                                                                OutputStream out)

getFileExtend

protected String getFileExtend(int format)
                        throws RuntimeException
Get the file extend.

Throws:
RuntimeException

isMatchLayout

public boolean isMatchLayout()
If match the layout.

Returns:
selection of match layout.

setMatchLayout

public void setMatchLayout(boolean matched)
Set the match lay out.


getViewsheet

protected String getViewsheet()

getBookmark

public String getBookmark()

getBookmarkUser

public String getBookmarkUser()

getScheduleEmails

public String getScheduleEmails(inetsoft.report.composition.execution.ViewsheetSandbox box)

getAlerts

public ScheduleAlert[] getAlerts()
Gets the alert conditions for this action.

Returns:
the alert conditions.

setAlerts

public void setAlerts(ScheduleAlert[] alerts)
Sets the alert conditions for this action.

Parameters:
alerts - the alert conditions.

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