de.innovationgate.wga.server.api.tml

Interface Portlet

All Known Implementing Classes:

TMLPortlet

public interface Portlet

Represents a WebTML portlet and its configuration. This object is the same as the TMLPortlet object in TMLScript. Documentation on this object and its methods in more detail can therefor be found on the TMLScript reference of the OpenWGA documenation library of the respective OpenWGA version for Object "TMLPortlet".

Method Summary

Methods

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

Method Detail

child

Portlet child(java.lang.String name)
              throws de.innovationgate.webgate.api.WGAPIException

Returns a child portlet of the given name

Parameters:

name - The portlet name

Throws:

de.innovationgate.webgate.api.WGAPIException

cleanup

void cleanup()
             throws de.innovationgate.webgate.api.WGAPIException

Clears the portlet configuration and state

Throws:

de.innovationgate.webgate.api.WGAPIException

clearchildstate

void clearchildstate(java.lang.String name)
                     throws de.innovationgate.webgate.api.WGAPIException

Clears the state of a child portlet

Parameters:

name - The portlet name

Throws:

de.innovationgate.webgate.api.WGAPIException

clearstate

void clearstate()
                throws de.innovationgate.webgate.api.WGAPIException

Clears the portlet state

Throws:

de.innovationgate.webgate.api.WGAPIException

fireevent

void fireevent(PortletEvent event)

Fires a portlet event

Parameters:

event - The portlet event

fireevent

void fireevent(java.lang.String eventname)

Fires a new portlet event of the given name

Parameters:

eventname - The name of the portlet event

fireevent

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

Parameters:

eventName - The name of the portlet event

params - Parameters added to the event

forcestate

void forcestate()
                throws de.innovationgate.webgate.api.WGAPIException

Forces a state on a portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

getchildrennames

java.util.List<java.lang.String> getchildrennames()
                                                  throws de.innovationgate.webgate.api.WGAPIException

Returns the names of registered child portlets

Throws:

de.innovationgate.webgate.api.WGAPIException

getcontext

Context getcontext()
                   throws de.innovationgate.webgate.api.WGAPIException

Gets the portlet context

Throws:

de.innovationgate.webgate.api.WGAPIException

getitemnames

java.util.List<java.lang.String> getitemnames()
                                              throws de.innovationgate.webgate.api.WGAPIException

Returns the names of items on this portlet configuration

Throws:

de.innovationgate.webgate.api.WGAPIException

getmode

java.lang.String getmode()
                         throws de.innovationgate.webgate.api.WGAPIException

Returns the current portlet mode

Throws:

de.innovationgate.webgate.api.WGAPIException

getname

java.lang.String getname()

Returns the name of the portlet

getportletpath

java.lang.String getportletpath()
                                throws de.innovationgate.webgate.api.WGAPIException

Returns the absolute path of this portlet, consisting of a path of from names of all portlets up to the root

Throws:

de.innovationgate.webgate.api.WGAPIException

getroot

Portlet getroot()
                throws de.innovationgate.webgate.api.WGAPIException

Retrieves the root portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

getsessionvar

java.lang.Object getsessionvar(java.lang.String name)
                               throws de.innovationgate.webgate.api.WGAPIException

Retrieves the value of a WebTML portlet session variable

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

getsourceportlet

Portlet getsourceportlet(PortletEvent event)
                         throws de.innovationgate.webgate.api.WGAPIException

Returns the portlet that threw a portlet event

Parameters:

event - The portlet event

Throws:

de.innovationgate.webgate.api.WGAPIException

gettml

java.lang.String gettml()

Returns the name of the layout WebTML module for this portlet

gettmldb

java.lang.String gettmldb()

Returns the key of the application containing the layout module of this portlet

getvar

java.lang.Object getvar(java.lang.String name)
                        throws de.innovationgate.webgate.api.WGAPIException

Retrieves the value of a normal WebTML portlet variable

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

hasitem

boolean hasitem(java.lang.String name)
                throws de.innovationgate.webgate.api.WGAPIException

Tests if an item exists on the portlet configuration

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

isroot

boolean isroot()

Shows if this portlet is the root portlet

item

java.lang.Object item(java.lang.String name)
                      throws de.innovationgate.webgate.api.WGAPIException

Returns the value of an item from portlet configuration as a single value

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

itemlist

java.util.List<java.lang.Object> itemlist(java.lang.String name)
                                          throws de.innovationgate.webgate.api.WGAPIException

Returns the value of an item from portlet configuration as a list value

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

parent

Portlet parent()
               throws de.innovationgate.webgate.api.WGAPIException

Returns the parent portlet. If this is the root portlet returns null.

Throws:

de.innovationgate.webgate.api.WGAPIException

registerportletforname

java.lang.String registerportletforname(java.lang.String name,
                                      java.lang.String module)
                                        throws de.innovationgate.webgate.api.WGException

Registers a new child portlet

Parameters:

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.

Returns:

The internal portlet key of the created portlet

Throws:

de.innovationgate.webgate.api.WGException

registerportletforname

java.lang.String registerportletforname(java.lang.String name,
                                      java.lang.String module,
                                      boolean overwrite)
                                        throws de.innovationgate.webgate.api.WGException

Registers a new child portlet

Parameters:

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

overwrite - Controls if an already existing portlet registration may be overwritten. If false an error is thrown when the given name is already registered.

Returns:

The internal portlet key of the created portlet

Throws:

de.innovationgate.webgate.api.WGException

registerportletforname

java.lang.String registerportletforname(java.lang.String name,
                                      java.lang.String moduleDb,
                                      java.lang.String module)
                                        throws de.innovationgate.webgate.api.WGException

Registers a new child portlet

Parameters:

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 layout

Returns:

The internal portlet key of the created portlet

Throws:

de.innovationgate.webgate.api.WGException

registerportletforname

java.lang.String registerportletforname(java.lang.String name,
                                      java.lang.String moduleDb,
                                      java.lang.String module,
                                      boolean overwrite)
                                        throws de.innovationgate.webgate.api.WGException

Registers a new child portlet

Parameters:

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 layout

overwrite - Controls if an already existing portlet registration may be overwritten. If false an error is thrown when the given name is already registered.

Returns:

The internal portlet key of the created portlet

Throws:

de.innovationgate.webgate.api.WGException

removeitem

void removeitem(java.lang.String name)
                throws de.innovationgate.webgate.api.WGAPIException

Removes an item from portlet configuration

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

removesessionvar

void removesessionvar(java.lang.String name)
                      throws de.innovationgate.webgate.api.WGAPIException

Removes a WebTML portlet session variable

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

removevar

void removevar(java.lang.String name)
               throws de.innovationgate.webgate.api.WGAPIException

Removes a WebTML portlet variable

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

setcontext

void setcontext(Context context)
                throws de.innovationgate.webgate.api.WGAPIException

Sets the portlet context

Throws:

de.innovationgate.webgate.api.WGAPIException

setitem

boolean setitem(java.lang.String name,
              java.lang.Object value)
                throws de.innovationgate.webgate.api.WGAPIException

Sets an item in portlet configuration

Parameters:

name - Name of the item

value - Value of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

setmode

void setmode(java.lang.String mode)
             throws de.innovationgate.webgate.api.WGAPIException

Sets the current portlet mode

Parameters:

mode - The mode to set

Throws:

de.innovationgate.webgate.api.WGAPIException

setsessionvar

void setsessionvar(java.lang.String name,
                 java.lang.Object value)
                   throws de.innovationgate.webgate.api.WGAPIException

Sets a WebTML portlet session variable. This variant creates session variables that are allowed for serialisation in a cluster..

Parameters:

name - Name of the variable

value - Value of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

setsessionvar

void setsessionvar(java.lang.String name,
                 java.lang.Object value,
                 boolean allowSerialization)
                   throws de.innovationgate.webgate.api.WGAPIException

Sets a WebTML portlet session variable

Parameters:

name - Name of the variable

value - Value of the variable

allowSerialization - 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.

Throws:

de.innovationgate.webgate.api.WGAPIException

setvar

void setvar(java.lang.String name,
          java.lang.Object value)
            throws de.innovationgate.webgate.api.WGAPIException

Sets a WebTML portlet variable

Parameters:

name - Name of the variable

value - Value of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

unregister

void unregister()
                throws de.innovationgate.webgate.api.WGAPIException

Removes the current portlet from portlet registry.

Throws:

de.innovationgate.webgate.api.WGAPIException

unregisterchildportlets

void unregisterchildportlets()
                             throws de.innovationgate.webgate.api.WGAPIException

Removes all child portlets from portlet registry

Throws:

de.innovationgate.webgate.api.WGAPIException

unregisterportletforname

void unregisterportletforname(java.lang.String name)
                              throws de.innovationgate.webgate.api.WGAPIException

Removes a child portlet from portlet registry

Parameters:

name - Name of the child portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

getcontroller

java.lang.Object getcontroller()
                               throws de.innovationgate.webgate.api.WGAPIException,
                                      de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException