public interface GenticsPortlet extends javax.portlet.Portlet, Changeable, EventHandler, GenticsPluginServer, javax.portlet.ResourceServingPortlet
Modifier and Type | Method and Description |
---|---|
void |
afterProcessAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse response) |
Datasource |
getDatasource(String id)
get a datasource by id
|
FileUploadProvider |
getFileUploadProvider() |
String |
getFullModuleType()
Get the full module type (including the application prefix)
|
GenticsPortletContext |
getGenticsPortletContext()
returns the GenticsPortletContext
|
String |
getModuleId()
returns the module ID
|
String |
getModuleType()
get the module type
|
javax.portlet.PortletConfig |
getPortletConfig()
Returns the PortletConfig object of this portlet.
|
javax.portlet.PortletContext |
getPortletContext()
returns the portlet context this method is within our genticsmodule
interface as we closely relate to the javax.portlet.GenericPortlet of the
JSR 168 Specification.
|
javax.portlet.PortletRequest |
getPortletRequest()
returns the PortletRequest of this module
the portlet request is created when setting the request for this module
|
TemplateProcessor |
getTemplateProcessor(javax.portlet.RenderRequest renderRequest,
javax.portlet.RenderResponse renderResponse)
Deprecated.
|
I18nString |
i18n(String key)
get a localized string.
|
void |
reloadModule()
This method is called if a module has to be reloaded.
|
void |
returnFileUploadProvider() |
void |
setModuleType(String applicationPrefix,
String moduleType)
Set the application prefix and portlet name
|
void |
setRequest(javax.portlet.PortletRequest request)
sets the request for the current module, will be needed to transform into
a portlet request
|
setProperty
canResolve, get, getProperty
handleEvent
afterProcessPluginAction, getPlugin, onPluginEvent, processPluginAction, registerPlugin, renderPlugin, unregisterPlugin
void setRequest(javax.portlet.PortletRequest request)
request
- requestString getModuleId()
String getModuleType()
String getFullModuleType()
void setModuleType(String applicationPrefix, String moduleType)
applicationPrefix
- application prefixmoduleType
- module type (portlet name)javax.portlet.PortletRequest getPortletRequest()
javax.portlet.PortletConfig getPortletConfig()
GenticsPortletContext getGenticsPortletContext()
javax.portlet.PortletContext getPortletContext()
void afterProcessAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
FileUploadProvider getFileUploadProvider()
void returnFileUploadProvider()
TemplateProcessor getTemplateProcessor(javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse)
GenticsPortletContext.getTemplateProcessor(GenticsPortlet, PortletConfig)
instead.renderRequest
- render requestrenderResponse
- render responsevoid reloadModule()
Datasource getDatasource(String id)
id
- Id of Datasource as defined in portalconfiguration.I18nString i18n(String key)
key
- the key of the i18n item. the syntax is [a-z0-9.]+, and will
generate a warning if violated.Copyright © 2014 Gentics Software GmbH. All Rights Reserved.