|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GenticsPortlet
The Module Interface enhances the JSR 168 defined Standard Portlet by adding Methods and interfaces needed for best efficent use within Gentics Portal.Node
Method Summary | |
---|---|
void |
afterProcessAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse response)
|
Datasource |
getDatasource(java.lang.String id)
get a datasource by id |
FileUploadProvider |
getFileUploadProvider()
|
java.lang.String |
getFullModuleType()
Get the full module type (including the application prefix) |
GenticsPortletContext |
getGenticsPortletContext()
returns the GenticsPortletContext |
java.lang.String |
getModuleId()
returns the module ID |
java.lang.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. use GenticsPortletContext.getTemplateProcessor(GenticsPortlet, PortletConfig) instead. |
I18nString |
i18n(java.lang.String key)
get a localized string. |
void |
reloadModule()
This method is called if a module has to be reloaded. |
void |
returnFileUploadProvider()
|
void |
setModuleType(java.lang.String applicationPrefix,
java.lang.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 |
Methods inherited from interface javax.portlet.Portlet |
---|
destroy, init, processAction, render |
Methods inherited from interface com.gentics.api.lib.resolving.Changeable |
---|
setProperty |
Methods inherited from interface com.gentics.api.lib.resolving.Resolvable |
---|
canResolve, get, getProperty |
Methods inherited from interface com.gentics.api.portalnode.event.EventHandler |
---|
handleEvent |
Methods inherited from interface com.gentics.api.portalnode.plugin.GenticsPluginServer |
---|
afterProcessPluginAction, getPlugin, onPluginEvent, processPluginAction, registerPlugin, renderPlugin, unregisterPlugin |
Methods inherited from interface javax.portlet.ResourceServingPortlet |
---|
serveResource |
Method Detail |
---|
void setRequest(javax.portlet.PortletRequest request)
request
- requestjava.lang.String getModuleId()
java.lang.String getModuleType()
java.lang.String getFullModuleType()
void setModuleType(java.lang.String applicationPrefix, java.lang.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 response
void reloadModule()
Datasource getDatasource(java.lang.String id)
id
- Id of Datasource as defined in portalconfiguration.
I18nString i18n(java.lang.String key)
key
- the key of the i18n item. the syntax is [a-z0-9.]+, and will
generate a warning if violated.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |