Package com.simplicite.util
Class ExternalObject
- java.lang.Object
-
- com.simplicite.util.ExternalObject
-
- All Implemented Interfaces:
CacheInterface
,java.io.Serializable
- Direct Known Subclasses:
JQueryWebPageExternalObject
,ResponsiveExternalObject
,RESTServiceExternalObject
,ScriptedExternalObject
,StaticSiteExternalObject
,WebPageExternalObject
public class ExternalObject extends java.lang.Object implements java.io.Serializable, CacheInterface
External object definition- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAUT_MIME_TYPE
Default MIME type
-
Constructor Summary
Constructors Constructor Description ExternalObject()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addChartjs()
Add Chart.js® componentsvoid
addExtraCSS(java.lang.String extracss)
Set extra CSS filevoid
addExtraCSS(java.lang.String[] extracss)
Set extra CSS filesvoid
addExtraJS(java.lang.String extrajs)
Add extra JS filevoid
addExtraJS(java.lang.String[] extrajs)
Add extra JS filesvoid
addFullCalendar(java.lang.String lang)
Add FullCalendar® components Needs sysparam FULLCALENDAR_VERSION = 3 or 4 (3 as default for backward compatibility)void
addJQPlot()
Add JQPlot® componentsvoid
addMarkdown()
Add Markdown componentsvoid
addMustache()
Add Mustache® componentsvoid
addSharedScript(SharedScript s)
Add a shared codevoid
addVue()
Add Vue® componentsvoid
appendChartjs()
Same as addChartjs (for syntax compatibility with com.simplicite.webapp.WebPage)void
appendCSSInclude(java.lang.String extracss)
Same as addExtraCSS (for syntax compatibility with com.simplicite.webapp.WebPage)void
appendCSSIncludes(java.lang.String[] extracss)
Same as addExtraCSS (for syntax compatibility with com.simplicite.webapp.WebPage)void
appendFullCalendar(java.lang.String lang)
Same as addFullCalendar (for syntax compatibility with com.simplicite.webapp.WebPage)void
appendJQPlot()
Same as addJQPlot (for syntax compatibility with com.simplicite.webapp.WebPage)void
appendJSInclude(java.lang.String extrajs)
Same as addExtraJS (for syntax compatibility with com.simplicite.webapp.WebPage)void
appendJSIncludes(java.lang.String[] extrajs)
Same as addExtraJS (for syntax compatibility with com.simplicite.webapp.WebPage)void
appendMarkdown()
Same as addMarkdown (for syntax compatibility with com.simplicite.webapp.WebPage)void
appendMustache()
Same as addMustache (for syntax compatibility with com.simplicite.webapp.WebPage)void
appendVue()
Same as addVue (for syntax compatibility with com.simplicite.webapp.WebPage)java.lang.Object
display(Parameters params)
Display methodvoid
enableGC(boolean enabled)
Empty, always disabledjava.lang.Object
evalExpression(java.lang.String expr, java.util.Map<java.lang.String,java.lang.Object> in, java.util.Map<java.lang.String,java.lang.Object> out)
Prepare and evaluate an expression (see prepareExpression for details on tokens)boolean
garbageCollection()
Empty, external object are not managedboolean
getBooleanParameter(java.lang.String name, boolean def)
Gets one boolean parameterjava.lang.String
getCacheKey(Grant g)
Get object unique cache keyjava.lang.String
getClassName()
Get external object class nameConsole
getConsole()
Get consolejava.lang.String
getContentDisposition()
Get content dispositionjava.util.List<java.lang.String>
getCSSResources()
Get CSS resource codesjava.lang.String
getDesc()
Get descriptionjava.lang.String
getDisplay()
Get display labeldouble
getDoubleParameter(java.lang.String name, double def)
Gets one double parameterjava.lang.String[]
getExtraCSS()
Get extra CSS filesjava.lang.String[]
getExtraJS()
Get extra JS filesboolean
getFlagParameter(java.lang.String name)
Gets one boolean flag parameterfloat
getFloatParameter(java.lang.String name, float def)
Gets one float parameterGrant
getGrant()
Get grantjava.lang.String
getHelp()
Get helpjava.lang.String
getHTML()
Get HTMLjava.util.List<java.lang.String>
getHTMLResources()
Get HTML resource codesint
getHTTPStatus()
Get HTTP statusjava.lang.String
getIconCode()
Get icon codejava.lang.String
getId()
Get external object definition IDjava.util.List<java.lang.String>
getImageResources()
Get images resource codesint
getIntParameter(java.lang.String name, int def)
Gets one integer parameterjava.util.List<java.lang.String>
getJSResources()
Get JavaScript resource codesjava.lang.String
getLabel()
Get display label (alias to getDisplay)long
getLongParameter(java.lang.String name, long def)
Gets one long parameterint
getMaxAge()
Get max agejava.lang.String
getMimeType()
Deprecated.Use getMIMETypejava.lang.String
getMIMEType()
Get MIME typejava.lang.String
getModuleId()
Get external object module IDjava.lang.String
getModuleName()
Get external object module namejava.lang.String
getName()
Get namejava.lang.Object
getObjectParameter(java.lang.String name)
Gets one object parameterjava.lang.String
getParameter(java.lang.String name)
Gets a text parameterjava.lang.String
getParameter(java.lang.String name, java.lang.String def)
Gets a text parameterResource
getResource(java.lang.String code)
Get a resourcebyte[]
getResourceContent(java.lang.String type, java.lang.String code)
Get external object's Resource contentjava.lang.String
getResourceCSSContent(java.lang.String code)
Get external object's CSS Resource contentjava.lang.String
getResourceCSSURL(java.lang.String code)
Get external object's CSS Resource URLjava.lang.String
getResourceHTMLContent(java.lang.String code)
Get external object's HTML Resource contentjava.lang.String
getResourceHTMLURL(java.lang.String code)
Get external object's HTML Resource URLjava.lang.String
getResourceJSContent(java.lang.String code)
Get external object's JS Resource contentjava.lang.String
getResourceJSURL(java.lang.String code)
Get external object's JS Resource URLbyte[]
getResourcePDFContent(java.lang.String code)
Get external object's PDF Resource contentjava.lang.String
getResourcePDFURL(java.lang.String code)
Get external object's PDF Resource URLjava.util.List<Resource>
getResources()
Get all resourcesjava.lang.String
getResourceURL(java.lang.String type, java.lang.String code)
Get external object's Resource URLjava.lang.String
getRoot()
Get rootjava.lang.String
getScriptId()
Get server script document IDjava.util.List<SharedScript>
getSharedScripts()
Get all shared codesjava.lang.String
getTarget()
Get targetjava.lang.String
getURL()
Get URLboolean
hasDecoration()
Has decoration ?boolean
hasJSGlobals()
Has JS parameters ?boolean
hasJSParameters()
Has JS parameters ?boolean
hasResources()
Has resources automatic inclusion?boolean
hasTitle()
Has title?java.lang.String
httpRedirect(Parameters params, java.lang.String url)
Generate an HTTP redirect (alias to sendHttpRedirect)java.lang.String
invokeAction(Action action)
Action call without parametersjava.lang.String
invokeAction(Action action, java.util.Map<java.lang.String,java.lang.String> params)
Action call with optional parametersjava.lang.String
invokeAction(java.lang.String actionName)
Action call without parametersjava.lang.String
invokeAction(java.lang.String actionName, java.util.Map<java.lang.String,java.lang.String> params)
Action call with optional parameters * @param actionName Action nameboolean
isJavaImplemented()
Is implemented in Java?boolean
isPublic()
Is running in public zonejava.lang.String
javascript(java.lang.String js)
Generate a JavaScript statement to be returned by the display method (alias to sendJavaScript)long
lastUsage(boolean update)
Returns -1 = no internal GCjava.lang.String
prepareExpression(java.lang.String expr)
Prepares an expression applying following token substitutions:
- [OBJECTID] : the current object ID
- [OBJECT] : the current object
- [OBJECTNAME] or [OBJNAME] : the current object name
- [OBJECTLABEL] or [OBJLABEL] : the current object label
- [PARAM:<parameter name>]: object parameter value
NB: It first calls Grant.prepareExpression() for grant level token substitutions.java.lang.String
readScript(boolean force)
Read server script document content (read using getScriptId())java.lang.String
redirect(java.lang.String url)
Generate a redirect statement to be returned by the display method (alias to sendRedirect)void
removeParameter(java.lang.String name)
Unsets a parametervoid
removeParameters(java.lang.String prefix)
Unsets parameters starting with prefixjava.lang.String
sendHttpRedirect(Parameters params, java.lang.String url)
Generate an HTTP redirectjava.lang.String
sendJavaScript(java.lang.String js)
Generate a JavaScript statement to be returned by the display methodjava.lang.String
sendRedirect(java.lang.String url)
Generate a redirect statement to be returned by the display methodvoid
setClassName(java.lang.String cls)
Set external object class namevoid
setConsole(Console console)
Set consolevoid
setContentDisposition(java.lang.String disp, java.lang.String filename)
Set content dispositionvoid
setCSVMIMEType()
Set CSV MIME type shorthandvoid
setDecoration(boolean d)
Set decorationvoid
setDisplay(java.lang.String d)
Set display labelvoid
setGrant(Grant g)
Set grantvoid
setHelp(java.lang.String h)
Set helpvoid
setHTML(java.lang.String html)
Set HTMLvoid
setHTMLMIMEType()
Set HTML MIME type shorthandvoid
setHTTPStatus(int s)
Set HTTP statusvoid
setIconCode(java.lang.String i)
Set icon codevoid
setId(java.lang.String id)
Set external object definition IDvoid
setJavaImplemented(boolean b)
Set implemented in Javavoid
setJSGlobals(boolean g)
Set JS globalsvoid
setJSONMIMEType()
Set JSON MIME type shorthandvoid
setJSParameters(boolean p)
Set JS parametersvoid
setLabel(java.lang.String d)
Set display label (alias to setDisplay)void
setMaxAge(int m)
Set max agevoid
setMimeType(java.lang.String m)
Deprecated.Use setMIMETypevoid
setMIMEType(java.lang.String m)
Set MIME typevoid
setModuleId(java.lang.String id)
Set external object module IDvoid
setModuleName(java.lang.String mdl)
Set external object module namevoid
setMSExcelMIMEType()
Set Microsoft Excel MIME type shorthandvoid
setMSPowerPointMIMEType()
Set Microsoft PowerPoint MIME type shorthandvoid
setMSWordMIMEType()
Set Microsoft Word MIME type shorthandvoid
setName(java.lang.String n)
Set external object namevoid
setParameter(java.lang.String name, boolean b)
Set parametervoid
setParameter(java.lang.String name, double d)
Set parametervoid
setParameter(java.lang.String name, float f)
Set parametervoid
setParameter(java.lang.String name, int i)
Set parametervoid
setParameter(java.lang.String name, long l)
Set parametervoid
setParameter(java.lang.String name, java.lang.Object value)
Sets one parameter in the object instance (useful, for instance, to store data thru different pages and contexts)void
setPDFMIMEType()
Set PDF MIME type shorthandvoid
setPublic(boolean p)
Set as running in public zonevoid
setResources(boolean d)
Set resources automatic inclusionvoid
setRoot(java.lang.String r)
Set rootvoid
setScriptId(java.lang.String id)
Set server script document IDvoid
setTarget(java.lang.String t)
Set targetvoid
setTextMIMEType()
Set XML MIME type shorthandvoid
setTitle(boolean t)
Set titlevoid
setTSVMIMEType()
Set TSV MIME type shorthandvoid
setURL(java.lang.String u)
Set URLvoid
setUseCalculator(boolean u)
Set use calculatorvoid
setUseCalendar(boolean u)
Set use calendarvoid
setUseCharts(boolean u)
Set use chartsvoid
setUseCompletion(boolean u)
Set use completionvoid
setUseHTMLEditor(boolean u)
Set use HTML editorvoid
setUseTreeview(boolean u)
Set use treeviewvoid
setXMLMIMEType()
Set XML MIME type shorthandvoid
setYAMLMIMEType()
Set YAML MIME type shorthandvoid
setZIPMIMEType()
Set ZIP MIME type shorthandorg.json.JSONObject
toJSONObject()
Generates a JSON object representation of the business objectjava.lang.String
toString()
Generates a string representation of the business objectjava.lang.String
unitTests()
Unit testsboolean
useCalculator()
Use calculator?boolean
useCalendar()
Use calendar?boolean
useCharts()
Use charts?boolean
useCompletion()
Use completion?boolean
useHTMLEditor()
Use HTML editor?boolean
useTreeview()
Use treeview?
-
-
-
Method Detail
-
setId
public void setId(java.lang.String id)
Set external object definition ID- Parameters:
id
- external object definition ID
-
getId
public java.lang.String getId()
Get external object definition ID- Returns:
- external object definition ID
-
setName
public void setName(java.lang.String n)
Set external object name- Parameters:
n
- external object name
-
getName
public java.lang.String getName()
Get name- Specified by:
getName
in interfaceCacheInterface
- Returns:
- name
-
setModuleId
public void setModuleId(java.lang.String id)
Set external object module ID- Parameters:
id
- external object module ID
-
getModuleId
public java.lang.String getModuleId()
Get external object module ID- Returns:
- external object module ID
-
setModuleName
public void setModuleName(java.lang.String mdl)
Set external object module name- Parameters:
mdl
- external object module name
-
getModuleName
public java.lang.String getModuleName()
Get external object module name- Returns:
- external object module name
-
setClassName
public void setClassName(java.lang.String cls)
Set external object class name- Parameters:
cls
- external object class name
-
getClassName
public java.lang.String getClassName()
Get external object class name- Returns:
- external object class name
-
isJavaImplemented
public boolean isJavaImplemented()
Is implemented in Java?- Specified by:
isJavaImplemented
in interfaceCacheInterface
- Returns:
- True if implemented in Java
-
setJavaImplemented
public void setJavaImplemented(boolean b)
Set implemented in Java- Parameters:
b
- Implemented in Java?
-
getConsole
public Console getConsole()
Get console
-
setConsole
public void setConsole(Console console)
Set console
-
setDisplay
public void setDisplay(java.lang.String d)
Set display label- Parameters:
d
- Display Label
-
setLabel
public void setLabel(java.lang.String d)
Set display label (alias to setDisplay)- Parameters:
d
- Display label
-
getDisplay
public java.lang.String getDisplay()
Get display label- Returns:
- Display label
-
getLabel
public java.lang.String getLabel()
Get display label (alias to getDisplay)- Returns:
- Display label
-
setHelp
public void setHelp(java.lang.String h)
Set help- Parameters:
h
- help
-
getHelp
public java.lang.String getHelp()
Get help- Returns:
- help
-
setIconCode
public void setIconCode(java.lang.String i)
Set icon code- Parameters:
i
- icon code
-
getIconCode
public java.lang.String getIconCode()
Get icon code- Returns:
- icon code
-
getDesc
public java.lang.String getDesc()
Get description- Returns:
- Description
-
setScriptId
public void setScriptId(java.lang.String id)
Set server script document ID- Parameters:
id
- server script document ID
-
getScriptId
public java.lang.String getScriptId()
Get server script document ID- Returns:
- server script document id
-
readScript
public java.lang.String readScript(boolean force)
Read server script document content (read using getScriptId())- Parameters:
force
- force ?- Returns:
- server script
-
getSharedScripts
public java.util.List<SharedScript> getSharedScripts()
Get all shared codes- Returns:
- all shared codes
-
addSharedScript
public void addSharedScript(SharedScript s)
Add a shared code- Parameters:
s
- shared code
-
setURL
public void setURL(java.lang.String u)
Set URL- Parameters:
u
- URL
-
getURL
public java.lang.String getURL()
Get URL- Returns:
- URL
-
setTarget
public void setTarget(java.lang.String t)
Set target- Parameters:
t
- target
-
getTarget
public java.lang.String getTarget()
Get target- Returns:
- target
-
setPublic
public void setPublic(boolean p)
Set as running in public zone- Parameters:
p
- public zone ?
-
isPublic
public boolean isPublic()
Is running in public zone- Returns:
- Is running in public zone
-
setRoot
public void setRoot(java.lang.String r)
Set root- Parameters:
r
- Root
-
getRoot
public java.lang.String getRoot()
Get root- Returns:
- Root
-
setGrant
public void setGrant(Grant g)
Set grant- Parameters:
g
- Grant
-
getGrant
public Grant getGrant()
Get grant- Returns:
- Grant
-
getCacheKey
public java.lang.String getCacheKey(Grant g)
Get object unique cache key- Specified by:
getCacheKey
in interfaceCacheInterface
- Parameters:
g
- Grant- Returns:
- Unique cache key
-
enableGC
public void enableGC(boolean enabled)
Empty, always disabled- Specified by:
enableGC
in interfaceCacheInterface
- Parameters:
enabled
- false to disable internal GC
-
lastUsage
public long lastUsage(boolean update)
Returns -1 = no internal GC- Specified by:
lastUsage
in interfaceCacheInterface
- Parameters:
update
- true to update the last usage date of object- Returns:
- last usage date in milliseconds
-
garbageCollection
public boolean garbageCollection()
Empty, external object are not managed- Specified by:
garbageCollection
in interfaceCacheInterface
- Returns:
- True if something has been cleared
-
setMimeType
@Deprecated public final void setMimeType(java.lang.String m)
Deprecated.Use setMIMEType
-
setMIMEType
public void setMIMEType(java.lang.String m)
Set MIME type- Parameters:
m
- MIME type
-
getMimeType
@Deprecated public final java.lang.String getMimeType()
Deprecated.Use getMIMEType
-
getMIMEType
public java.lang.String getMIMEType()
Get MIME type- Returns:
- MIME type
-
setHTMLMIMEType
public void setHTMLMIMEType()
Set HTML MIME type shorthand
-
setJSONMIMEType
public void setJSONMIMEType()
Set JSON MIME type shorthand
-
setYAMLMIMEType
public void setYAMLMIMEType()
Set YAML MIME type shorthand
-
setXMLMIMEType
public void setXMLMIMEType()
Set XML MIME type shorthand
-
setTextMIMEType
public void setTextMIMEType()
Set XML MIME type shorthand
-
setCSVMIMEType
public void setCSVMIMEType()
Set CSV MIME type shorthand
-
setTSVMIMEType
public void setTSVMIMEType()
Set TSV MIME type shorthand
-
setPDFMIMEType
public void setPDFMIMEType()
Set PDF MIME type shorthand
-
setMSExcelMIMEType
public void setMSExcelMIMEType()
Set Microsoft Excel MIME type shorthand
-
setMSWordMIMEType
public void setMSWordMIMEType()
Set Microsoft Word MIME type shorthand
-
setMSPowerPointMIMEType
public void setMSPowerPointMIMEType()
Set Microsoft PowerPoint MIME type shorthand
-
setZIPMIMEType
public void setZIPMIMEType()
Set ZIP MIME type shorthand
-
setContentDisposition
public void setContentDisposition(java.lang.String disp, java.lang.String filename)
Set content disposition- Parameters:
disp
- dispositionfilename
- file
-
getContentDisposition
public java.lang.String getContentDisposition()
Get content disposition- Returns:
- content disposition
-
setMaxAge
public void setMaxAge(int m)
Set max age- Parameters:
m
- max age
-
getMaxAge
public int getMaxAge()
Get max age- Returns:
- max age
-
setHTTPStatus
public void setHTTPStatus(int s)
Set HTTP status- Parameters:
s
- HTTP status
-
getHTTPStatus
public int getHTTPStatus()
Get HTTP status- Returns:
- HTTP status
-
setDecoration
public void setDecoration(boolean d)
Set decoration- Parameters:
d
- decoration
-
hasDecoration
public boolean hasDecoration()
Has decoration ?- Returns:
- Has decoration
-
setResources
public void setResources(boolean d)
Set resources automatic inclusion- Parameters:
d
- resources automatic inclusion
-
hasResources
public boolean hasResources()
Has resources automatic inclusion?- Returns:
- Has resources?
-
setTitle
public void setTitle(boolean t)
Set title- Parameters:
t
- title
-
hasTitle
public boolean hasTitle()
Has title?- Returns:
- Has title?
-
setJSGlobals
public void setJSGlobals(boolean g)
Set JS globals- Parameters:
g
- JS globals
-
hasJSGlobals
public boolean hasJSGlobals()
Has JS parameters ?- Returns:
- Has JS parameters
-
setJSParameters
public void setJSParameters(boolean p)
Set JS parameters- Parameters:
p
- JS parameters
-
hasJSParameters
public boolean hasJSParameters()
Has JS parameters ?- Returns:
- Has JS parameters
-
addExtraJS
public void addExtraJS(java.lang.String extrajs)
Add extra JS file- Parameters:
extrajs
- extra JS file
-
appendJSInclude
public void appendJSInclude(java.lang.String extrajs)
Same as addExtraJS (for syntax compatibility with com.simplicite.webapp.WebPage)- Parameters:
extrajs
- extra JS files
-
addExtraJS
public void addExtraJS(java.lang.String[] extrajs)
Add extra JS files- Parameters:
extrajs
- extra JS files
-
appendJSIncludes
public void appendJSIncludes(java.lang.String[] extrajs)
Same as addExtraJS (for syntax compatibility with com.simplicite.webapp.WebPage)- Parameters:
extrajs
- extra JS files
-
getExtraJS
public java.lang.String[] getExtraJS()
Get extra JS files- Returns:
- extra JS files
-
setUseCalendar
public void setUseCalendar(boolean u)
Set use calendar- Parameters:
u
- Use calendar?
-
useCalendar
public boolean useCalendar()
Use calendar?- Returns:
- True if use calendar
-
setUseCalculator
public void setUseCalculator(boolean u)
Set use calculator- Parameters:
u
- Use calculator?
-
useCalculator
public boolean useCalculator()
Use calculator?- Returns:
- True if use calculator
-
setUseHTMLEditor
public void setUseHTMLEditor(boolean u)
Set use HTML editor- Parameters:
u
- Use HTML editor?
-
useHTMLEditor
public boolean useHTMLEditor()
Use HTML editor?- Returns:
- True is use HTML editor
-
setUseTreeview
public void setUseTreeview(boolean u)
Set use treeview- Parameters:
u
- Use treeview?
-
useTreeview
public boolean useTreeview()
Use treeview?- Returns:
- True if use treeview
-
setUseCompletion
public void setUseCompletion(boolean u)
Set use completion- Parameters:
u
- Use completion?
-
useCompletion
public boolean useCompletion()
Use completion?- Returns:
- True if use completion
-
setUseCharts
public void setUseCharts(boolean u)
Set use charts- Parameters:
u
- Use charts?
-
useCharts
public boolean useCharts()
Use charts?- Returns:
- True if use charts
-
addExtraCSS
public void addExtraCSS(java.lang.String extracss)
Set extra CSS file- Parameters:
extracss
- extra CSS files
-
appendCSSInclude
public void appendCSSInclude(java.lang.String extracss)
Same as addExtraCSS (for syntax compatibility with com.simplicite.webapp.WebPage)- Parameters:
extracss
- extra CSS files
-
addExtraCSS
public void addExtraCSS(java.lang.String[] extracss)
Set extra CSS files- Parameters:
extracss
- extra CSS files
-
appendCSSIncludes
public void appendCSSIncludes(java.lang.String[] extracss)
Same as addExtraCSS (for syntax compatibility with com.simplicite.webapp.WebPage)- Parameters:
extracss
- extra CSS files
-
getExtraCSS
public java.lang.String[] getExtraCSS()
Get extra CSS files- Returns:
- extra CSS files
-
addMarkdown
public void addMarkdown()
Add Markdown components
-
appendMarkdown
public void appendMarkdown()
Same as addMarkdown (for syntax compatibility with com.simplicite.webapp.WebPage)
-
addMustache
public void addMustache()
Add Mustache® components
-
appendMustache
public void appendMustache()
Same as addMustache (for syntax compatibility with com.simplicite.webapp.WebPage)
-
addVue
public void addVue()
Add Vue® components
-
appendVue
public void appendVue()
Same as addVue (for syntax compatibility with com.simplicite.webapp.WebPage)
-
addJQPlot
public void addJQPlot()
Add JQPlot® components
-
appendJQPlot
public void appendJQPlot()
Same as addJQPlot (for syntax compatibility with com.simplicite.webapp.WebPage)
-
addChartjs
public void addChartjs()
Add Chart.js® components
-
appendChartjs
public void appendChartjs()
Same as addChartjs (for syntax compatibility with com.simplicite.webapp.WebPage)
-
addFullCalendar
public void addFullCalendar(java.lang.String lang)
Add FullCalendar® components Needs sysparam FULLCALENDAR_VERSION = 3 or 4 (3 as default for backward compatibility)
-
appendFullCalendar
public void appendFullCalendar(java.lang.String lang)
Same as addFullCalendar (for syntax compatibility with com.simplicite.webapp.WebPage)
-
setHTML
public void setHTML(java.lang.String html)
Set HTML- Parameters:
html
- HTML
-
getHTML
public java.lang.String getHTML()
Get HTML- Returns:
- HTML
-
display
public java.lang.Object display(Parameters params)
Display method- Parameters:
params
- Parameters- Returns:
- Content to display (either as String for text content or as byte array for binary content)
-
getResourceURL
public java.lang.String getResourceURL(java.lang.String type, java.lang.String code)
Get external object's Resource URL- Parameters:
type
- Resource typecode
- Resource code- Returns:
- Resource URL
-
getResourceContent
public byte[] getResourceContent(java.lang.String type, java.lang.String code)
Get external object's Resource content- Parameters:
type
- Resource typecode
- Resource code- Returns:
- Resource content (as byte array)
-
getResourceHTMLURL
public java.lang.String getResourceHTMLURL(java.lang.String code)
Get external object's HTML Resource URL- Parameters:
code
- Resource code- Returns:
- Resource URL
-
getResourceHTMLContent
public java.lang.String getResourceHTMLContent(java.lang.String code)
Get external object's HTML Resource content- Parameters:
code
- Resource code- Returns:
- Resource content (as string)
-
getResourceJSURL
public java.lang.String getResourceJSURL(java.lang.String code)
Get external object's JS Resource URL- Parameters:
code
- Resource code- Returns:
- Resource URL
-
getResourceJSContent
public java.lang.String getResourceJSContent(java.lang.String code)
Get external object's JS Resource content- Parameters:
code
- Resource code- Returns:
- Resource content (as string)
-
getResourceCSSURL
public java.lang.String getResourceCSSURL(java.lang.String code)
Get external object's CSS Resource URL- Parameters:
code
- Resource code- Returns:
- Resource URL
-
getResourceCSSContent
public java.lang.String getResourceCSSContent(java.lang.String code)
Get external object's CSS Resource content- Parameters:
code
- Resource code- Returns:
- Resource content (as string)
-
getResourcePDFURL
public java.lang.String getResourcePDFURL(java.lang.String code)
Get external object's PDF Resource URL- Parameters:
code
- Resource code- Returns:
- Resource URL
-
getResourcePDFContent
public byte[] getResourcePDFContent(java.lang.String code)
Get external object's PDF Resource content- Parameters:
code
- Resource code- Returns:
- Resource content (as byte array)
-
sendRedirect
public java.lang.String sendRedirect(java.lang.String url)
Generate a redirect statement to be returned by the display method- Parameters:
url
- URL to redirect to
-
httpRedirect
public java.lang.String httpRedirect(Parameters params, java.lang.String url) throws java.io.IOException
Generate an HTTP redirect (alias to sendHttpRedirect)- Parameters:
params
- Request parametersurl
- URL to redirect to- Throws:
java.io.IOException
-
sendHttpRedirect
public java.lang.String sendHttpRedirect(Parameters params, java.lang.String url) throws java.io.IOException
Generate an HTTP redirect- Parameters:
params
- Request parametersurl
- URL to redirect to- Throws:
java.io.IOException
-
redirect
public java.lang.String redirect(java.lang.String url)
Generate a redirect statement to be returned by the display method (alias to sendRedirect)- Parameters:
url
- URL to redirect to
-
sendJavaScript
public java.lang.String sendJavaScript(java.lang.String js)
Generate a JavaScript statement to be returned by the display method- Parameters:
js
- JavaScript statement
-
javascript
public java.lang.String javascript(java.lang.String js)
Generate a JavaScript statement to be returned by the display method (alias to sendJavaScript)- Parameters:
js
- JavaScript statement
-
setParameter
public void setParameter(java.lang.String name, boolean b)
Set parameter- Parameters:
name
- Nameb
- Value
-
setParameter
public void setParameter(java.lang.String name, int i)
Set parameter- Parameters:
name
- Namei
- Value
-
setParameter
public void setParameter(java.lang.String name, long l)
Set parameter- Parameters:
name
- Namel
- Value
-
setParameter
public void setParameter(java.lang.String name, float f)
Set parameter- Parameters:
name
- Namef
- Value
-
setParameter
public void setParameter(java.lang.String name, double d)
Set parameter- Parameters:
name
- Named
- Value
-
setParameter
public void setParameter(java.lang.String name, java.lang.Object value)
Sets one parameter in the object instance (useful, for instance, to store data thru different pages and contexts)- Parameters:
name
- Parameter namevalue
- Parameter value, if null the parameter name is removed
-
removeParameter
public void removeParameter(java.lang.String name)
Unsets a parameter- Parameters:
name
- Parameter name
-
removeParameters
public void removeParameters(java.lang.String prefix)
Unsets parameters starting with prefix- Parameters:
prefix
- Parameter prefix
-
getParameter
public java.lang.String getParameter(java.lang.String name)
Gets a text parameter- Parameters:
name
- Parameter name- Returns:
- Object parameter value (null if not found)
-
getParameter
public java.lang.String getParameter(java.lang.String name, java.lang.String def)
Gets a text parameter- Parameters:
name
- Parameter namedef
- Default value- Returns:
- Object parameter value
-
getObjectParameter
public java.lang.Object getObjectParameter(java.lang.String name)
Gets one object parameter- Parameters:
name
- Parameter name- Returns:
- Object parameter
-
getIntParameter
public int getIntParameter(java.lang.String name, int def)
Gets one integer parameter- Parameters:
name
- Parameter namedef
- Default value if parsing fails- Returns:
- Integer parameter value
-
getLongParameter
public long getLongParameter(java.lang.String name, long def)
Gets one long parameter- Parameters:
name
- Parameter namedef
- Default value if parsing fails- Returns:
- Long parameter value
-
getFloatParameter
public float getFloatParameter(java.lang.String name, float def)
Gets one float parameter- Parameters:
name
- Parameter namedef
- Default value if parsing fails- Returns:
- Float parameter value
-
getDoubleParameter
public double getDoubleParameter(java.lang.String name, double def)
Gets one double parameter- Parameters:
name
- Parameter namedef
- Default value if parsing fails- Returns:
- Double parameter value
-
getBooleanParameter
public boolean getBooleanParameter(java.lang.String name, boolean def)
Gets one boolean parameter- Parameters:
name
- Parameter namedef
- Default value if parsing fails- Returns:
- Boolean parameter value
-
getFlagParameter
public boolean getFlagParameter(java.lang.String name)
Gets one boolean flag parameter- Parameters:
name
- Parameter name- Returns:
- Boolean flag parameter value (defaults to false)
-
evalExpression
public java.lang.Object evalExpression(java.lang.String expr, java.util.Map<java.lang.String,java.lang.Object> in, java.util.Map<java.lang.String,java.lang.Object> out) throws ScriptException
Prepare and evaluate an expression (see prepareExpression for details on tokens)- Parameters:
expr
- Expressionin
- Input variables to set before expression evaluationout
- Output variables to retrieve after expression evaluation- Returns:
- Expression evaluation result
- Throws:
ScriptException
- ScriptException
-
prepareExpression
public java.lang.String prepareExpression(java.lang.String expr) throws ScriptException
Prepares an expression applying following token substitutions:
- [OBJECTID] : the current object ID
- [OBJECT] : the current object
- [OBJECTNAME] or [OBJNAME] : the current object name
- [OBJECTLABEL] or [OBJLABEL] : the current object label
- [PARAM:<parameter name>]: object parameter value
NB: It first calls Grant.prepareExpression() for grant level token substitutions.- Parameters:
expr
- Expression including tokens to substitute- Returns:
- Prepared expression
- Throws:
ScriptException
- ScriptException
-
invokeAction
public final java.lang.String invokeAction(java.lang.String actionName) throws java.lang.Exception
Action call without parameters- Parameters:
actionName
- Action name- Returns:
- Action result
- Throws:
java.lang.Exception
-
invokeAction
public final java.lang.String invokeAction(java.lang.String actionName, java.util.Map<java.lang.String,java.lang.String> params) throws java.lang.Exception
Action call with optional parameters * @param actionName Action name- Parameters:
params
- Optional parameters- Returns:
- Action result
- Throws:
java.lang.Exception
-
invokeAction
public final java.lang.String invokeAction(Action action) throws GrantException, ActionException
Action call without parameters- Parameters:
action
- Action- Returns:
- Action result
- Throws:
GrantException
ActionException
-
invokeAction
public java.lang.String invokeAction(Action action, java.util.Map<java.lang.String,java.lang.String> params) throws GrantException, ActionException
Action call with optional parameters- Parameters:
action
- Actionparams
- Optional parameters- Returns:
- Action result
- Throws:
GrantException
ActionException
-
getImageResources
public java.util.List<java.lang.String> getImageResources()
Get images resource codes- Returns:
- images resource codes
-
getJSResources
public java.util.List<java.lang.String> getJSResources()
Get JavaScript resource codes- Returns:
- javascript resource codes
-
getCSSResources
public java.util.List<java.lang.String> getCSSResources()
Get CSS resource codes- Returns:
- css resource codes
-
getHTMLResources
public java.util.List<java.lang.String> getHTMLResources()
Get HTML resource codes- Returns:
- HTML resources
-
getResources
public java.util.List<Resource> getResources()
Get all resources- Returns:
- All resources
-
getResource
public Resource getResource(java.lang.String code)
Get a resource- Parameters:
code
- Resource code- Returns:
- Resource or null
-
unitTests
public java.lang.String unitTests()
Unit tests- Returns:
- Unit tests results
-
toJSONObject
public org.json.JSONObject toJSONObject()
Generates a JSON object representation of the business object- Returns:
- business object as JSON object
-
toString
public java.lang.String toString()
Generates a string representation of the business object- Overrides:
toString
in classjava.lang.Object
- Returns:
- business object as string
-
-