Style Intelligence v12.0

inetsoft.sree
Class RepletContext

java.lang.Object
  extended by inetsoft.sree.DefaultContext
      extended by inetsoft.sree.RepletContext
All Implemented Interfaces:
Serializable

public class RepletContext
extends DefaultContext

Replet context store basic information about a replet. It is used internally to retrieve information about a replet.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class inetsoft.sree.DefaultContext
description, name
 
Constructor Summary
RepletContext(String name, String alias, String description, String layout, RepletRequest init, RepletRequest def, boolean userDefined)
          Create a replet context.
RepletContext(String name, String alias, String description, String layout, RepletRequest init, RepletRequest def, int priority, boolean userDefined)
          Create a replet context.
 
Method Summary
 boolean equals(Object obj)
           
 String getAlias()
          Get replet alias name.
 RepletRequest getDefaultRequest()
          Get the default creation parameters.
 String getExportFormats()
          Get the replet's export formats.
 RepletRequest getInitRequest()
          Get the initialization parameters.
 String getLayout()
          Get replet layout option.
 String getPregeneratedCycle()
          Get the replet's pregenerated cycle.
 int getPriority()
          Get the template file associated with this replet.
 RepletParameters getRepletParameters(String name)
          Get replet parameters.
 int getReportMode()
          Get the current report mode.
 String getTemplate()
          Get the template file associated with this replet.
 ViewerAction[] getViewerActions()
          Get the user defined ViewerActions for the replet associated with this RepletContext.
 boolean isBursting()
          Check if the replet is a bursting report.
 boolean isChanged()
          Check if the replet has been changed since its last save.
 boolean isDirectFile()
          Check whether the replet is deployed in "Report Files" directory.
 boolean isParamOnly()
          Check if the replet is a parameters only report.
 boolean isPortlet()
          Check if the replet is a portlet.
 boolean isPregenerated()
          Check if the replet is a pregenerated.
 boolean isSystem()
          Determines if the replet is a system replet.
 boolean isUserDefined()
          Determines if the replet is from a user defined class or from a template.
 boolean isVisible()
          Check if replet is visible on the repository tree.
 void setAlias(String alias)
          Set replet alias name.
 void setBursting(boolean burst)
          Set the report bursting flag.
 void setChanged(boolean changed)
          Set the changed flag.
 void setDefaultRequest(RepletRequest def)
          Set the default creation parameters.
 void setDirectFile(boolean directlyFile)
          Set whether the replet is deployed in "Report Files" directory.
 void setExportFormats(String exportFormats)
          Set the replet's export formats.
 void setInitRequest(RepletRequest init)
          Set the initialization parameters.
 void setLayout(String layout)
          Set replet layout option.
 void setParamOnly(boolean paramOnly)
          Set the report parameters only flag.
 void setPortlet(boolean portlet)
          Set the portlet flag.
 void setPregenerated(boolean pregenerated)
          Set the pregenerated flag.
 void setPregeneratedCycle(String pregeneratedCycle)
          Set the replet's pregenerated cycle.
 void setPriority(int priority)
          Set the template file used by this replet.
 void setRepletParameters(RepletParameters param)
          Set replet parameters.
 void setRepletRequest(RepletRequest req)
          Set replet request.
 void setReportMode(int rmode)
          Set the current report mode.
 void setSystem(boolean system)
          Sets whether the replet is a system replet.
 void setTemplate(String template)
          Set the template file used by this replet.
 void setUserDefined(boolean userDefined)
          Sets whether the replet is from a user defined class or from a template.
 void setViewerActions(ViewerAction[] viewerActions)
          Set the user defined Viewer Actions for the replet associated with this RepletContext.
 void setVisible(boolean vis)
          Set replet visibility.
 
Methods inherited from class inetsoft.sree.DefaultContext
getDescription, getName, setDescription, setName
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RepletContext

public RepletContext(String name,
                     String alias,
                     String description,
                     String layout,
                     RepletRequest init,
                     RepletRequest def,
                     boolean userDefined)
Create a replet context.


RepletContext

public RepletContext(String name,
                     String alias,
                     String description,
                     String layout,
                     RepletRequest init,
                     RepletRequest def,
                     int priority,
                     boolean userDefined)
Create a replet context.

Method Detail

getAlias

public String getAlias()
Get replet alias name.


setAlias

public void setAlias(String alias)
Set replet alias name.


getLayout

public String getLayout()
Get replet layout option.


setLayout

public void setLayout(String layout)
Set replet layout option.


isVisible

public boolean isVisible()
Check if replet is visible on the repository tree.


setVisible

public void setVisible(boolean vis)
Set replet visibility.


getTemplate

public String getTemplate()
Get the template file associated with this replet.


setTemplate

public void setTemplate(String template)
Set the template file used by this replet.


getPriority

public int getPriority()
Get the template file associated with this replet.


setPriority

public void setPriority(int priority)
Set the template file used by this replet.


getDefaultRequest

public RepletRequest getDefaultRequest()
Get the default creation parameters.


setDefaultRequest

public void setDefaultRequest(RepletRequest def)
Set the default creation parameters.


getInitRequest

public RepletRequest getInitRequest()
Get the initialization parameters.


setInitRequest

public void setInitRequest(RepletRequest init)
Set the initialization parameters.


setRepletRequest

public void setRepletRequest(RepletRequest req)
Set replet request.


setRepletParameters

public void setRepletParameters(RepletParameters param)
Set replet parameters.


getRepletParameters

public RepletParameters getRepletParameters(String name)
Get replet parameters.


isDirectFile

public boolean isDirectFile()
Check whether the replet is deployed in "Report Files" directory.


setDirectFile

public void setDirectFile(boolean directlyFile)
Set whether the replet is deployed in "Report Files" directory.


equals

public boolean equals(Object obj)
Overrides:
equals in class Object

setViewerActions

public void setViewerActions(ViewerAction[] viewerActions)
Set the user defined Viewer Actions for the replet associated with this RepletContext.

Parameters:
viewerActions - an array of user defined viewer actions.

getViewerActions

public ViewerAction[] getViewerActions()
Get the user defined ViewerActions for the replet associated with this RepletContext.

Returns:
array of user defined ViewerActions

getReportMode

public int getReportMode()
Get the current report mode.


setReportMode

public void setReportMode(int rmode)
Set the current report mode. One of the mode defined in Replet class.


isChanged

public boolean isChanged()
Check if the replet has been changed since its last save.


setChanged

public void setChanged(boolean changed)
Set the changed flag.


setPortlet

public void setPortlet(boolean portlet)
Set the portlet flag.


isPortlet

public boolean isPortlet()
Check if the replet is a portlet.


setBursting

public void setBursting(boolean burst)
Set the report bursting flag.


isBursting

public boolean isBursting()
Check if the replet is a bursting report.


setPregenerated

public void setPregenerated(boolean pregenerated)
Set the pregenerated flag.


isPregenerated

public boolean isPregenerated()
Check if the replet is a pregenerated.


setParamOnly

public void setParamOnly(boolean paramOnly)
Set the report parameters only flag.


isParamOnly

public boolean isParamOnly()
Check if the replet is a parameters only report.


setPregeneratedCycle

public void setPregeneratedCycle(String pregeneratedCycle)
Set the replet's pregenerated cycle.


getPregeneratedCycle

public String getPregeneratedCycle()
Get the replet's pregenerated cycle.


setExportFormats

public void setExportFormats(String exportFormats)
Set the replet's export formats.


getExportFormats

public String getExportFormats()
Get the replet's export formats.


isSystem

public boolean isSystem()
Determines if the replet is a system replet. System replets are not directly used by the user and may not be modified.

Returns:
true if the replet is a system replet.
Since:
8.5

setSystem

public void setSystem(boolean system)
Sets whether the replet is a system replet. System replets are not directly used by the user and may not be modified.

Parameters:
system - true if the replet is a system replet.
Since:
8.5

isUserDefined

public boolean isUserDefined()
Determines if the replet is from a user defined class or from a template.

Returns:
true if the replet is from a user defined class.
Since:
8.5

setUserDefined

public void setUserDefined(boolean userDefined)
Sets whether the replet is from a user defined class or from a template.

Parameters:
userDefined - true if the replet is from a user defined class.
Since:
8.5

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