de.innovationgate.wgpublisher.webtml.portlet

Class TMLPortlet

java.lang.Object

de.innovationgate.wgpublisher.webtml.portlet.TMLPortlet

All Implemented Interfaces:

Portlet, TMLObject

public class TMLPortlet
extends java.lang.Object
implements TMLObject, Portlet

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PORTLET_MODE
static java.lang.String	PORTLETCONTEXT_NONE
static java.util.regex.Pattern	PORTLETNAME_PATTERN
static java.lang.String	REQATTRIB_FIRED_PORTLET_EVENTS
TMLContext	tmlContext

Constructor Summary

Constructors

Constructor and Description
TMLPortlet()
TMLPortlet(TMLContext tmlContext, TMLUserProfile profile, de.innovationgate.webgate.api.WGPortlet portlet)

Method Summary

Methods

Modifier and Type	Method and Description
void	changeDesign(java.lang.String tml)
TMLPortlet	child(java.lang.String name) Returns a child portlet of the given name
void	cleanup() Clears the portlet configuration and state
void	cleanup(java.lang.String portletKey)
void	clearchildstate(java.lang.String name) Clears the state of a child portlet
void	clearstate() Clears the portlet state
boolean	equals(java.lang.Object obj)
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
de.innovationgate.webgate.api.WGDocument	getapiobject()
java.util.List<java.lang.String>	getchildrenkeys()
java.util.List<java.lang.String>	getchildrennames() Returns the names of registered child portlets
TMLContext	getcontext() Gets the portlet context
java.lang.Object	getcontroller()
Design	getControllerDesign()
java.util.List<java.lang.String>	getdescendantkeys()
java.util.List<java.lang.String>	getdescendantnames()
java.lang.String	getDesign()
static org.apache.commons.collections.map.LinkedMap	getFiredEventsQueue(javax.servlet.http.HttpSession session) Queue that stores the last 1000 fired portlet events, so portlets can react on them with serverside code.
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	getparentkey()
TMLPortlet	getparentportlet()
TMLPortlet	getportlet(java.lang.String key)
TMLPortlet	getportletforname(java.lang.String name)
java.lang.String	getportletkey() Returns the title.
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
de.innovationgate.webgate.api.WGPortlet	getPortletRegistration(java.lang.String key)
TMLUserProfile	getProfile()
de.innovationgate.webgate.api.WGPortlet	getReg()
TMLPortlet	getroot() Retrieves the root portlet
java.lang.Object	getsessionvar(java.lang.String name) Retrieves the value of a WebTML portlet session variable
TMLPortlet	getsourceportlet(PortletEvent event) Returns the portlet that threw a portlet event
TMLPortletState	getState()
java.lang.String	gettitle()
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
java.lang.String	getVarPrefix()
static java.lang.String	getVarPrefix(java.lang.String portletKey)
int	hashCode()
boolean	hasitem(java.lang.String name) Tests if an item exists on the portlet configuration
boolean	hassessionvar(java.lang.String name)
boolean	iscontextset()
boolean	isprovisionalstate()
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
void	markedited()
java.lang.Object	meta(java.lang.String name)
java.util.List<java.lang.Object>	metalist(java.lang.String name)
TMLPortlet	parent() Returns the parent portlet.
void	prepareEventProcessing(Base tag)
java.lang.String	registerportlet(java.lang.String tmlCode, java.lang.String title)
java.lang.String	registerportlet(java.lang.String tmlDb, java.lang.String tmlCode, java.lang.String title)
java.lang.String	registerportletforname(java.lang.String name, DesignResourceReference ref, boolean overwrite)
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 appDbKey, java.lang.String resourceName, 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
java.lang.Object	retrieveSessionVar(java.lang.String name)
boolean	save()
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	setsessionvar(java.lang.String name, java.lang.Object value, boolean allowSerialization, boolean keepList)
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
boolean	unregisterportlet(java.lang.String portletKey)
void	unregisterportletforname(java.lang.String name) Removes a child portlet from portlet registry

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PORTLET_MODE

public static final java.lang.String DEFAULT_PORTLET_MODE

See Also:

Constant Field Values

PORTLETNAME_PATTERN

public static final java.util.regex.Pattern PORTLETNAME_PATTERN

REQATTRIB_FIRED_PORTLET_EVENTS

public static final java.lang.String REQATTRIB_FIRED_PORTLET_EVENTS

PORTLETCONTEXT_NONE

public static final java.lang.String PORTLETCONTEXT_NONE

See Also:

Constant Field Values

tmlContext

public TMLContext tmlContext

Constructor Detail

TMLPortlet

public TMLPortlet(TMLContext tmlContext,
          TMLUserProfile profile,
          de.innovationgate.webgate.api.WGPortlet portlet)
           throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

TMLPortlet

public TMLPortlet()

Method Detail

getFiredEventsQueue

public static org.apache.commons.collections.map.LinkedMap getFiredEventsQueue(javax.servlet.http.HttpSession session)

Queue that stores the last 1000 fired portlet events, so portlets can react on them with serverside code.

Parameters:

session -

Returns:

getapiobject

public de.innovationgate.webgate.api.WGDocument getapiobject()

Specified by:

getapiobject in interface TMLObject

See Also:

de.innovationgate.wgpublisher.webtml.utils.TMLObject#getAPIObject()

item

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

Description copied from interface: Portlet

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

Specified by:

item in interface Portlet

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

itemlist

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

Description copied from interface: Portlet

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

Specified by:

itemlist in interface Portlet

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

hasitem

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

Description copied from interface: Portlet

Tests if an item exists on the portlet configuration

Specified by:

hasitem in interface Portlet

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

meta

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

Throws:

de.innovationgate.webgate.api.WGAPIException

metalist

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

Throws:

de.innovationgate.webgate.api.WGAPIException

save

public boolean save()
             throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

setitem

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

Description copied from interface: Portlet

Sets an item in portlet configuration

Specified by:

setitem in interface Portlet

Parameters:

name - Name of the item

value - Value of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

setvar

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

Description copied from interface: Portlet

Sets a WebTML portlet variable

Specified by:

setvar in interface Portlet

Parameters:

name - Name of the variable

value - Value of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

getvar

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

Description copied from interface: Portlet

Retrieves the value of a normal WebTML portlet variable

Specified by:

getvar in interface Portlet

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

removevar

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

Description copied from interface: Portlet

Removes a WebTML portlet variable

Specified by:

removevar in interface Portlet

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

setsessionvar

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

Description copied from interface: Portlet

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

Specified by:

setsessionvar in interface Portlet

Parameters:

name - Name of the variable

value - Value of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

getsessionvar

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

Description copied from interface: Portlet

Retrieves the value of a WebTML portlet session variable

Specified by:

getsessionvar in interface Portlet

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

hassessionvar

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

Throws:

de.innovationgate.webgate.api.WGAPIException

retrieveSessionVar

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

Throws:

de.innovationgate.webgate.api.WGAPIException

setsessionvar

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

Description copied from interface: Portlet

Sets a WebTML portlet session variable

Specified by:

setsessionvar in interface Portlet

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

setsessionvar

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

Throws:

de.innovationgate.webgate.api.WGAPIException

removesessionvar

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

Description copied from interface: Portlet

Removes a WebTML portlet session variable

Specified by:

removesessionvar in interface Portlet

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGAPIException

removeitem

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

Description copied from interface: Portlet

Removes an item from portlet configuration

Specified by:

removeitem in interface Portlet

Parameters:

name - Name of the item

Throws:

de.innovationgate.webgate.api.WGAPIException

getportlet

public TMLPortlet getportlet(java.lang.String key)
                      throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

getPortletRegistration

public de.innovationgate.webgate.api.WGPortlet getPortletRegistration(java.lang.String key)
                                                               throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

getparentportlet

public TMLPortlet getparentportlet()
                            throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

getchildrenkeys

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

Throws:

de.innovationgate.webgate.api.WGAPIException

getdescendantkeys

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

Throws:

de.innovationgate.webgate.api.WGAPIException

getchildrennames

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

Description copied from interface: Portlet

Returns the names of registered child portlets

Specified by:

getchildrennames in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

getdescendantnames

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

Throws:

de.innovationgate.webgate.api.WGAPIException

registerportlet

public java.lang.String registerportlet(java.lang.String tmlDb,
                               java.lang.String tmlCode,
                               java.lang.String title)
                                 throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

registerportlet

public java.lang.String registerportlet(java.lang.String tmlCode,
                               java.lang.String title)
                                 throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

unregisterportlet

public boolean unregisterportlet(java.lang.String portletKey)
                          throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

unregister

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

Description copied from interface: Portlet

Removes the current portlet from portlet registry.

Specified by:

unregister in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

cleanup

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

Description copied from interface: Portlet

Clears the portlet configuration and state

Specified by:

cleanup in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

clearstate

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

Description copied from interface: Portlet

Clears the portlet state

Specified by:

clearstate in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

forcestate

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

Description copied from interface: Portlet

Forces a state on a portlet

Specified by:

forcestate in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

clearchildstate

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

Description copied from interface: Portlet

Clears the state of a child portlet

Specified by:

clearchildstate in interface Portlet

Parameters:

name - The portlet name

Throws:

de.innovationgate.webgate.api.WGAPIException

cleanup

public void cleanup(java.lang.String portletKey)
             throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

getportletkey

public java.lang.String getportletkey()

Returns the title.

Returns:

String

getparentkey

public java.lang.String getparentkey()

gettml

public java.lang.String gettml()

Description copied from interface: Portlet

Returns the name of the layout WebTML module for this portlet

Specified by:

gettml in interface Portlet

gettmldb

public java.lang.String gettmldb()

Description copied from interface: Portlet

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

Specified by:

gettmldb in interface Portlet

getitemnames

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

Description copied from interface: Portlet

Returns the names of items on this portlet configuration

Specified by:

getitemnames in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

gettitle

public java.lang.String gettitle()

getname

public java.lang.String getname()

Description copied from interface: Portlet

Returns the name of the portlet

Specified by:

getname in interface Portlet

getmode

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

Description copied from interface: Portlet

Returns the current portlet mode

Specified by:

getmode in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

getState

public TMLPortletState getState()
                         throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

getcontroller

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

Specified by:

getcontroller in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

de.innovationgate.webgate.api.WGException

getVarPrefix

public static java.lang.String getVarPrefix(java.lang.String portletKey)

setmode

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

Description copied from interface: Portlet

Sets the current portlet mode

Specified by:

setmode in interface Portlet

Parameters:

mode - The mode to set

Throws:

de.innovationgate.webgate.api.WGAPIException

changeDesign

public void changeDesign(java.lang.String tml)
                  throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

getDesign

public java.lang.String getDesign()

fireevent

public void fireevent(PortletEvent event)

Description copied from interface: Portlet

Fires a portlet event

Specified by:

fireevent in interface Portlet

Parameters:

event - The portlet event

fireevent

public void fireevent(java.lang.String eventname)

Description copied from interface: Portlet

Fires a new portlet event of the given name

Specified by:

fireevent in interface Portlet

Parameters:

eventname - The name of the portlet event

fireevent

public void fireevent(java.lang.String eventName,
             java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: Portlet

Fires a new portlet event of the given name with the given parameters

Specified by:

fireevent in interface Portlet

Parameters:

eventName - The name of the portlet event

params - Parameters added to the event

registerportletforname

public java.lang.String registerportletforname(java.lang.String name,
                                      DesignResourceReference ref,
                                      boolean overwrite)
                                        throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

registerportletforname

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

Description copied from interface: Portlet

Registers a new child portlet

Specified by:

registerportletforname in interface Portlet

Parameters:

name - Name by which the portlet is registered. May consist of alphanumeric characters, dots, underlines and colons.

appDbKey - Database key of the application that hosts the WebTML module to use for portlet layout. Omit to use the current WebTML design application.

resourceName - 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

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

Description copied from interface: Portlet

Registers a new child portlet

Specified by:

registerportletforname in interface 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

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

Description copied from interface: Portlet

Registers a new child portlet

Specified by:

registerportletforname in interface 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

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

Description copied from interface: Portlet

Registers a new child portlet

Specified by:

registerportletforname in interface 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

getportletforname

public TMLPortlet getportletforname(java.lang.String name)
                             throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

unregisterportletforname

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

Description copied from interface: Portlet

Removes a child portlet from portlet registry

Specified by:

unregisterportletforname in interface Portlet

Parameters:

name - Name of the child portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

unregisterchildportlets

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

Description copied from interface: Portlet

Removes all child portlets from portlet registry

Specified by:

unregisterchildportlets in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

prepareEventProcessing

public void prepareEventProcessing(Base tag)
                            throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

isroot

public boolean isroot()

Description copied from interface: Portlet

Shows if this portlet is the root portlet

Specified by:

isroot in interface Portlet

getroot

public TMLPortlet getroot()
                   throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: Portlet

Retrieves the root portlet

Specified by:

getroot in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

parent

public TMLPortlet parent()
                  throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: Portlet

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

Specified by:

parent in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

child

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

Description copied from interface: Portlet

Returns a child portlet of the given name

Specified by:

child in interface Portlet

Parameters:

name - The portlet name

Throws:

de.innovationgate.webgate.api.WGAPIException

getcontext

public TMLContext getcontext()
                      throws de.innovationgate.webgate.api.WGAPIException

Description copied from interface: Portlet

Gets the portlet context

Specified by:

getcontext in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

iscontextset

public boolean iscontextset()
                     throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

isprovisionalstate

public boolean isprovisionalstate()
                           throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

setcontext

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

Description copied from interface: Portlet

Sets the portlet context

Specified by:

setcontext in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

getVarPrefix

public java.lang.String getVarPrefix()

getsourceportlet

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

Description copied from interface: Portlet

Returns the portlet that threw a portlet event

Specified by:

getsourceportlet in interface Portlet

Parameters:

event - The portlet event

Throws:

de.innovationgate.webgate.api.WGAPIException

getReg

public de.innovationgate.webgate.api.WGPortlet getReg()

getportletpath

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

Description copied from interface: Portlet

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

Specified by:

getportletpath in interface Portlet

Throws:

de.innovationgate.webgate.api.WGAPIException

getProfile

public TMLUserProfile getProfile()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

markedited

public void markedited()
                throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

getControllerDesign

public Design getControllerDesign()
                           throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException