public class ExternalObject extends java.lang.Object implements java.io.Serializable, CacheInterface
Constructor and Description |
---|
ExternalObject() |
Modifier and Type | Method and Description |
---|---|
void |
addExtraCSS(java.lang.String extracss)
Set extra CSS file
|
void |
addExtraCSS(java.lang.String[] extracss)
Set extra CSS files
|
void |
addExtraJS(java.lang.String extrajs)
Add extra JS file
|
void |
addExtraJS(java.lang.String[] extrajs)
Add extra JS files
|
void |
addSharedScript(Script s)
Add a shared script
|
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 |
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)
|
java.lang.Object |
display(Parameters params)
Custom content, defaults implementation is an HTML page with HTML resources as body and CSS and JS resources included in header
|
void |
enableGC(boolean enabled)
Empty, always disabled
|
java.lang.Object |
evalExpression(java.lang.String expr,
java.util.HashMap<java.lang.String,java.lang.Object> in,
java.util.HashMap<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 managed
|
boolean |
getBooleanParameter(java.lang.String name,
boolean def)
Gets one boolean parameter
|
java.lang.String |
getCacheKey(Grant g)
Get object unique cache key
|
java.lang.String |
getContentDisposition()
Get content disposition
|
java.util.Vector<java.lang.String> |
getCSSResources()
Get CSS resource codes
|
java.lang.String |
getDisplay()
Get display
|
double |
getDoubleParameter(java.lang.String name,
double def)
Gets one double parameter
|
java.lang.String[] |
getExtraCSS()
Get extra CSS files
|
java.lang.String[] |
getExtraJS()
Get extra JS files
|
boolean |
getFlagParameter(java.lang.String name)
Gets one boolean flag parameter
|
float |
getFloatParameter(java.lang.String name,
float def)
Gets one float parameter
|
Grant |
getGrant()
Get grant
|
java.lang.String |
getHelp()
Get help
|
java.util.Vector<java.lang.String> |
getHTMLResources()
Get HTML resource codes
|
int |
getHTTPStatus()
Get HTTP status
|
java.lang.String |
getIconCode()
Get icon code
|
java.lang.String |
getId()
Get object definition ID
|
java.util.Vector<java.lang.String> |
getImageResources()
Get images resource codes
|
int |
getIntParameter(java.lang.String name,
int def)
Gets one integer parameter
|
java.util.Vector<java.lang.String> |
getJSResources()
Get JavaScript resource codes
|
long |
getLongParameter(java.lang.String name,
long def)
Gets one long parameter
|
int |
getMaxAge()
Get max age
|
java.lang.String |
getMimeType()
Deprecated.
|
java.lang.String |
getMIMEType()
Get MIME type
|
java.lang.String |
getName()
Get name
|
java.lang.Object |
getObjectParameter(java.lang.String name)
Gets one object parameter
|
java.lang.String |
getParameter(java.lang.String name)
Gets a text parameter
|
java.lang.String |
getParameter(java.lang.String name,
java.lang.String def)
Gets a text parameter
|
java.lang.String |
getRoot()
Is running in public zone
|
java.lang.String |
getScriptId()
Get server script document ID
|
java.util.Vector<Script> |
getSharedScripts()
Get all shared scripts
|
java.lang.String |
getTarget()
Get target
|
java.lang.String |
getURL()
Get URL
|
boolean |
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 |
invokeAction(Action action)
Action call
|
java.lang.String |
invokeAction(java.lang.String actionName)
Action call
|
boolean |
isPublic()
Is running in public zone
|
long |
lastUsage(boolean update)
Returns -1 = no internal GC
|
java.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())
|
void |
removeParameter(java.lang.String name)
Unsets a parameter
|
void |
removeParameters(java.lang.String prefix)
Unsets parameters starting with prefix
|
java.lang.String |
sendRedirect(java.lang.String url)
Generate a redirect statement to be returned by the display method
|
void |
setContentDisposition(java.lang.String disp,
java.lang.String filename)
Set content disposition
|
void |
setDecoration(boolean d)
Set decoration
|
void |
setDisplay(java.lang.String d)
Set display
|
void |
setGrant(Grant g)
Set grant
|
void |
setHelp(java.lang.String h)
Set help
|
void |
setHTTPStatus(int s)
Set HTTP status
|
void |
setIconCode(java.lang.String i)
Set icon code
|
void |
setId(java.lang.String id)
Set object definition ID
|
void |
setJSGlobals(boolean g)
Set JS globals
|
void |
setJSParameters(boolean p)
Set JS parameters
|
void |
setMaxAge(int m)
Set max age
|
void |
setMimeType(java.lang.String m)
Deprecated.
|
void |
setMIMEType(java.lang.String m)
Set MIME type
|
void |
setName(java.lang.String d)
Set name
|
void |
setParameter(java.lang.String name,
boolean b) |
void |
setParameter(java.lang.String name,
double d) |
void |
setParameter(java.lang.String name,
float f) |
void |
setParameter(java.lang.String name,
int i) |
void |
setParameter(java.lang.String name,
long l) |
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)
|
void |
setPublic(boolean p)
Set as running in public zone
|
void |
setResources(boolean d)
Set resources automatic inclusion
|
void |
setRoot(java.lang.String r)
Set root
|
void |
setScriptId(java.lang.String id)
Set server script document ID
|
void |
setTarget(java.lang.String t)
Set target
|
void |
setTitle(boolean t)
Set title
|
void |
setURL(java.lang.String u)
Set URL
|
void |
setUseCalculator(boolean u) |
void |
setUseCalendar(boolean u) |
void |
setUseCharts(boolean u) |
void |
setUseCompletion(boolean u) |
void |
setUseHTMLEditor(boolean u) |
void |
setUseTreeview(boolean u) |
boolean |
useCalculator() |
boolean |
useCalendar() |
boolean |
useCharts() |
boolean |
useCompletion() |
boolean |
useHTMLEditor() |
boolean |
useTreeview() |
public void setId(java.lang.String id)
public java.lang.String getId()
public void setName(java.lang.String d)
public java.lang.String getName()
public void setDisplay(java.lang.String d)
public java.lang.String getDisplay()
public void setHelp(java.lang.String h)
public java.lang.String getHelp()
public void setIconCode(java.lang.String i)
public java.lang.String getIconCode()
public void setScriptId(java.lang.String id)
public java.lang.String getScriptId()
public java.lang.String readScript(boolean force)
public java.util.Vector<Script> getSharedScripts()
public void addSharedScript(Script s)
public void setURL(java.lang.String u)
public java.lang.String getURL()
public void setTarget(java.lang.String t)
public java.lang.String getTarget()
public void setPublic(boolean p)
public boolean isPublic()
public void setRoot(java.lang.String r)
public java.lang.String getRoot()
public void setGrant(Grant g)
public Grant getGrant()
public java.lang.String getCacheKey(Grant g)
getCacheKey
in interface CacheInterface
public void enableGC(boolean enabled)
enableGC
in interface CacheInterface
enabled
- false to disable internal GCpublic long lastUsage(boolean update)
lastUsage
in interface CacheInterface
update
- true to update the last usage date of objectpublic boolean garbageCollection()
garbageCollection
in interface CacheInterface
@Deprecated public final void setMimeType(java.lang.String m)
public void setMIMEType(java.lang.String m)
@Deprecated public final java.lang.String getMimeType()
public java.lang.String getMIMEType()
public void setContentDisposition(java.lang.String disp, java.lang.String filename)
public java.lang.String getContentDisposition()
public void setMaxAge(int m)
public int getMaxAge()
public void setHTTPStatus(int s)
public int getHTTPStatus()
public void setDecoration(boolean d)
public boolean hasDecoration()
public void setResources(boolean d)
public boolean hasResources()
public void setTitle(boolean t)
public boolean hasTitle()
public void setJSGlobals(boolean g)
public boolean hasJSGlobals()
public void setJSParameters(boolean p)
public boolean hasJSParameters()
public void addExtraJS(java.lang.String extrajs)
public void appendJSInclude(java.lang.String extrajs)
public void addExtraJS(java.lang.String[] extrajs)
public void appendJSIncludes(java.lang.String[] extrajs)
public java.lang.String[] getExtraJS()
public void setUseCalendar(boolean u)
public boolean useCalendar()
public void setUseCalculator(boolean u)
public boolean useCalculator()
public void setUseHTMLEditor(boolean u)
public boolean useHTMLEditor()
public void setUseTreeview(boolean u)
public boolean useTreeview()
public void setUseCompletion(boolean u)
public boolean useCompletion()
public void setUseCharts(boolean u)
public boolean useCharts()
public void addExtraCSS(java.lang.String extracss)
public void appendCSSInclude(java.lang.String extracss)
public void addExtraCSS(java.lang.String[] extracss)
public void appendCSSIncludes(java.lang.String[] extracss)
public java.lang.String[] getExtraCSS()
public java.lang.Object display(Parameters params)
Custom content, defaults implementation is an HTML page with HTML resources as body and CSS and JS resources included in header
params
- Parameterspublic java.lang.String sendRedirect(java.lang.String url)
Generate a redirect statement to be returned by the display method
url
- URL to redirect topublic void setParameter(java.lang.String name, boolean b)
public void setParameter(java.lang.String name, int i)
public void setParameter(java.lang.String name, long l)
public void setParameter(java.lang.String name, float f)
public void setParameter(java.lang.String name, double d)
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)
name
- Parameter namevalue
- Parameter value, if null the parameter name is removedpublic void removeParameter(java.lang.String name)
Unsets a parameter
name
- Parameter namepublic void removeParameters(java.lang.String prefix)
Unsets parameters starting with prefix
prefix
- Parameter prefixpublic java.lang.String getParameter(java.lang.String name)
Gets a text parameter
name
- Parameter namepublic java.lang.String getParameter(java.lang.String name, java.lang.String def)
Gets a text parameter
name
- Parameter namedef
- Default valuepublic java.lang.Object getObjectParameter(java.lang.String name)
Gets one object parameter
name
- Parameter namepublic int getIntParameter(java.lang.String name, int def)
Gets one integer parameter
name
- Parameter namepublic long getLongParameter(java.lang.String name, long def)
Gets one long parameter
name
- Parameter namepublic float getFloatParameter(java.lang.String name, float def)
Gets one float parameter
name
- Parameter namepublic double getDoubleParameter(java.lang.String name, double def)
Gets one double parameter
name
- Parameter namepublic boolean getBooleanParameter(java.lang.String name, boolean def)
Gets one boolean parameter
name
- Parameter namedef
- Default value if parsing failspublic boolean getFlagParameter(java.lang.String name)
Gets one boolean flag parameter
name
- Parameter namepublic java.lang.Object evalExpression(java.lang.String expr, java.util.HashMap<java.lang.String,java.lang.Object> in, java.util.HashMap<java.lang.String,java.lang.Object> out) throws com.simplicite.util.exceptions.ScriptException
expr
- Expressionin
- Input variables to set before expression evaluationout
- Output variables to retrieve after expression evaluationcom.simplicite.util.exceptions.ScriptException
public java.lang.String prepareExpression(java.lang.String expr) throws com.simplicite.util.exceptions.ScriptException
Prepares an expression applying following token substitutions:
expr
- Expression including tokens to substitutecom.simplicite.util.exceptions.ScriptException
public final java.lang.String invokeAction(java.lang.String actionName) throws java.lang.Exception
Action call
actionName
- Action namejava.lang.Exception
public java.lang.String invokeAction(Action action) throws com.simplicite.util.exceptions.GrantException, com.simplicite.util.exceptions.ActionException
Action call
action
- Actioncom.simplicite.util.exceptions.GrantException
com.simplicite.util.exceptions.ActionException
public java.util.Vector<java.lang.String> getImageResources()
public java.util.Vector<java.lang.String> getJSResources()
public java.util.Vector<java.lang.String> getCSSResources()
public java.util.Vector<java.lang.String> getHTMLResources()
Copyright (c)2006-2014 Simplicite Software. All Rights Reserved.