|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Replet
Replet defines the basic minimum API of a replet. It should not be used directly. All user replets should extend the BasicReplet class.
| Field Summary | |
|---|---|
static int |
DESIGN_MODE
Design mode. |
static int |
RUN_MODE
Run mode. |
| Method Summary | |
|---|---|
void |
destroy()
Destroy this replet. |
ReportSheet |
generate(RepletRequest req)
Generate a report. |
EventHandler |
getEventHandler()
Get the client-side event handler. |
int |
getEventMask()
Return the bitwise OR of all event masks this replet likes to receive events. |
Object |
getID()
Get the replet ID. |
String |
getName()
Get the replet name. |
Principal |
getPrincipal()
Get the principal of the user who created this replet. |
ReportSheet |
getPrintReport()
Get the original report with queries executed but scripts not yet executed. |
SelectionEvent[] |
getRegisteredSelections()
Get a list of registered selection events. |
RepletParameters |
getRepletParameters(String reqname)
Get the parameter descriptions of this replet. |
RepletRequest |
getRepletRequest()
Get last replet request used to generate the report of current replet. |
ReportSheet |
getReport()
Get the cached report. |
long |
getReportLastModified()
Get the report last modified time. |
int |
getReportMode()
Get report mode, should be DESIGN_MODE or RUN_MODE. |
VariableTable |
getVariableTable()
Get the variable table. |
RepletCommand |
handleEvent(EventObject e)
Process an event. |
void |
init(RepletRequest req)
Initialize the replet. |
void |
reexecute()
Reexecute the report. |
void |
regenerate()
Regenerate the report. |
void |
setChanged()
Set the changed flag. |
void |
setID(Object id)
Set the ID of this replet. |
void |
setName(String name)
Set the name of this replet. |
void |
setPrincipal(Principal principal)
Set the principal of the user who created this replet. |
void |
setRepletRequest(RepletRequest req)
Set the replet request to be used for generating report. |
void |
setReportMode(int mode)
Set report mode, should be DESIGN_MODE or RUN_MODE. |
void |
waitForLoaded()
Wait until report is loaded. |
| Field Detail |
|---|
static final int DESIGN_MODE
static final int RUN_MODE
| Method Detail |
|---|
void init(RepletRequest req)
throws RepletException
req - initialization request.
RepletExceptionvoid setPrincipal(Principal principal)
Principal getPrincipal()
void setID(Object id)
Object getID()
void setName(String name)
String getName()
void setReportMode(int mode)
mode - the specified report modeint getReportMode()
void regenerate()
throws RepletException
RepletExceptionvoid reexecute()
void setChanged()
VariableTable getVariableTable()
SelectionEvent[] getRegisteredSelections()
int getEventMask()
RepletParameters getRepletParameters(String reqname)
reqname - request name;
ReportSheet getReport()
void waitForLoaded()
throws RepletException
RepletExceptionReportSheet getPrintReport()
ReportSheet generate(RepletRequest req)
throws RepletException
req - replet request, including replet parameter values.
RepletExceptionEventHandler getEventHandler()
RepletCommand handleEvent(EventObject e)
e - event object.
long getReportLastModified()
RepletRequest getRepletRequest()
void setRepletRequest(RepletRequest req)
void destroy()
|
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 | ||||||||