public interface Portlet
Modifier and Type | Method and Description |
---|---|
Portlet |
child(java.lang.String name)
Returns a child portlet of the given name
|
void |
cleanup()
Clears the portlet configuration and state
|
void |
clearchildstate(java.lang.String name)
Clears the state of a child portlet
|
void |
clearstate()
Clears the portlet state
|
void |
fireevent(PortletEvent event)
Fires a portlet event
|
void |
fireevent(java.lang.String eventname)
Fires a new portlet event of the given name
|
void |
fireevent(java.lang.String eventName,
java.util.Map<java.lang.String,java.lang.Object> params)
Fires a new portlet event of the given name with the given parameters
|
void |
forcestate()
Forces a state on a portlet
|
java.util.List<java.lang.String> |
getchildrennames()
Returns the names of registered child portlets
|
Context |
getcontext()
Gets the portlet context
|
java.lang.Object |
getcontroller() |
java.util.List<java.lang.String> |
getitemnames()
Returns the names of items on this portlet configuration
|
java.lang.String |
getmode()
Returns the current portlet mode
|
java.lang.String |
getname()
Returns the name of the portlet
|
java.lang.String |
getportletpath()
Returns the absolute path of this portlet, consisting of a path of from names of all portlets up to the root
|
Portlet |
getroot()
Retrieves the root portlet
|
java.lang.Object |
getsessionvar(java.lang.String name)
Retrieves the value of a WebTML portlet session variable
|
Portlet |
getsourceportlet(PortletEvent event)
Returns the portlet that threw a portlet event
|
java.lang.String |
gettml()
Returns the name of the layout WebTML module for this portlet
|
java.lang.String |
gettmldb()
Returns the key of the application containing the layout module of this portlet
|
java.lang.Object |
getvar(java.lang.String name)
Retrieves the value of a normal WebTML portlet variable
|
boolean |
hasitem(java.lang.String name)
Tests if an item exists on the portlet configuration
|
boolean |
isroot()
Shows if this portlet is the root portlet
|
java.lang.Object |
item(java.lang.String name)
Returns the value of an item from portlet configuration as a single value
|
java.util.List<java.lang.Object> |
itemlist(java.lang.String name)
Returns the value of an item from portlet configuration as a list value
|
Portlet |
parent()
Returns the parent portlet.
|
java.lang.String |
registerportletforname(java.lang.String name,
java.lang.String module)
Registers a new child portlet
|
java.lang.String |
registerportletforname(java.lang.String name,
java.lang.String module,
boolean overwrite)
Registers a new child portlet
|
java.lang.String |
registerportletforname(java.lang.String name,
java.lang.String moduleDb,
java.lang.String module)
Registers a new child portlet
|
java.lang.String |
registerportletforname(java.lang.String name,
java.lang.String moduleDb,
java.lang.String module,
boolean overwrite)
Registers a new child portlet
|
void |
removeitem(java.lang.String name)
Removes an item from portlet configuration
|
void |
removesessionvar(java.lang.String name)
Removes a WebTML portlet session variable
|
void |
removevar(java.lang.String name)
Removes a WebTML portlet variable
|
void |
setcontext(Context context)
Sets the portlet context
|
boolean |
setitem(java.lang.String name,
java.lang.Object value)
Sets an item in portlet configuration
|
void |
setmode(java.lang.String mode)
Sets the current portlet mode
|
void |
setsessionvar(java.lang.String name,
java.lang.Object value)
Sets a WebTML portlet session variable.
|
void |
setsessionvar(java.lang.String name,
java.lang.Object value,
boolean allowSerialization)
Sets a WebTML portlet session variable
|
void |
setvar(java.lang.String name,
java.lang.Object value)
Sets a WebTML portlet variable
|
void |
unregister()
Removes the current portlet from portlet registry.
|
void |
unregisterchildportlets()
Removes all child portlets from portlet registry
|
void |
unregisterportletforname(java.lang.String name)
Removes a child portlet from portlet registry
|
Portlet child(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- The portlet namede.innovationgate.webgate.api.WGAPIException
void cleanup() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
void clearchildstate(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- The portlet namede.innovationgate.webgate.api.WGAPIException
void clearstate() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
void fireevent(PortletEvent event)
event
- The portlet eventvoid fireevent(java.lang.String eventname)
eventname
- The name of the portlet eventvoid fireevent(java.lang.String eventName, java.util.Map<java.lang.String,java.lang.Object> params)
eventName
- The name of the portlet eventparams
- Parameters added to the eventvoid forcestate() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
java.util.List<java.lang.String> getchildrennames() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
Context getcontext() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
java.util.List<java.lang.String> getitemnames() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
java.lang.String getmode() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
java.lang.String getname()
java.lang.String getportletpath() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
Portlet getroot() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
java.lang.Object getsessionvar(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the variablede.innovationgate.webgate.api.WGAPIException
Portlet getsourceportlet(PortletEvent event) throws de.innovationgate.webgate.api.WGAPIException
event
- The portlet eventde.innovationgate.webgate.api.WGAPIException
java.lang.String gettml()
java.lang.String gettmldb()
java.lang.Object getvar(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the variablede.innovationgate.webgate.api.WGAPIException
boolean hasitem(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the itemde.innovationgate.webgate.api.WGAPIException
boolean isroot()
java.lang.Object item(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the itemde.innovationgate.webgate.api.WGAPIException
java.util.List<java.lang.Object> itemlist(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the itemde.innovationgate.webgate.api.WGAPIException
Portlet parent() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
java.lang.String registerportletforname(java.lang.String name, java.lang.String module) throws de.innovationgate.webgate.api.WGException
name
- Name by which the portlet is registered. May consist of alphanumeric characters, dots, underlines and colons.module
- Name of the WebTML module to use for portlet layout.de.innovationgate.webgate.api.WGException
java.lang.String registerportletforname(java.lang.String name, java.lang.String module, boolean overwrite) throws de.innovationgate.webgate.api.WGException
name
- Name by which the portlet is registered. May consist of alphanumeric characters, dots, underlines and colons.module
- Name of the WebTML module to use for portlet layoutoverwrite
- Controls if an already existing portlet registration may be overwritten. If false an error is thrown when the given name is already registered.de.innovationgate.webgate.api.WGException
java.lang.String registerportletforname(java.lang.String name, java.lang.String moduleDb, java.lang.String module) throws de.innovationgate.webgate.api.WGException
name
- Name by which the portlet is registered. May consist of alphanumeric characters, dots, underlines and colons.moduleDb
- Database key of the application that hosts the WebTML module to use for portlet layout. Omit to use the current WebTML design application.module
- Name of the WebTML module to use for portlet layoutde.innovationgate.webgate.api.WGException
java.lang.String registerportletforname(java.lang.String name, java.lang.String moduleDb, java.lang.String module, boolean overwrite) throws de.innovationgate.webgate.api.WGException
name
- Name by which the portlet is registered. May consist of alphanumeric characters, dots, underlines and colons.moduleDb
- Database key of the application that hosts the WebTML module to use for portlet layout. Omit to use the current WebTML design application.module
- Name of the WebTML module to use for portlet layoutoverwrite
- Controls if an already existing portlet registration may be overwritten. If false an error is thrown when the given name is already registered.de.innovationgate.webgate.api.WGException
void removeitem(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the itemde.innovationgate.webgate.api.WGAPIException
void removesessionvar(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the variablede.innovationgate.webgate.api.WGAPIException
void removevar(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the variablede.innovationgate.webgate.api.WGAPIException
void setcontext(Context context) throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
boolean setitem(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the itemvalue
- Value of the itemde.innovationgate.webgate.api.WGAPIException
void setmode(java.lang.String mode) throws de.innovationgate.webgate.api.WGAPIException
mode
- The mode to setde.innovationgate.webgate.api.WGAPIException
void setsessionvar(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the variablevalue
- Value of the variablede.innovationgate.webgate.api.WGAPIException
void setsessionvar(java.lang.String name, java.lang.Object value, boolean allowSerialization) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the variablevalue
- Value of the variableallowSerialization
- Controls if this variable should be serialized to other cluster nodes in a server cluster. This is only possible if the value type is serializable.de.innovationgate.webgate.api.WGAPIException
void setvar(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the variablevalue
- Value of the variablede.innovationgate.webgate.api.WGAPIException
void unregister() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
void unregisterchildportlets() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
void unregisterportletforname(java.lang.String name) throws de.innovationgate.webgate.api.WGAPIException
name
- Name of the child portletde.innovationgate.webgate.api.WGAPIException
java.lang.Object getcontroller() throws de.innovationgate.webgate.api.WGAPIException, de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGException