com.gentics.api.portalnode.portlet
Interface GenticsPortlet

All Superinterfaces:
Changeable, EventHandler, GenticsPluginServer, javax.portlet.Portlet, Resolvable, javax.portlet.ResourceServingPortlet
All Known Implementing Classes:
AbstractGenticsPortlet

public interface GenticsPortlet
extends javax.portlet.Portlet, Changeable, EventHandler, GenticsPluginServer, javax.portlet.ResourceServingPortlet

The Module Interface enhances the JSR 168 defined Standard Portlet by adding Methods and interfaces needed for best efficent use within Gentics Portal.Node

Author:
Dietmar

Method Summary
 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. use GenticsPortletContext.getTemplateProcessor(GenticsPortlet, PortletConfig) instead.
 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
 
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

setRequest

void setRequest(javax.portlet.PortletRequest request)
sets the request for the current module, will be needed to transform into a portlet request

Parameters:
request - request

getModuleId

String getModuleId()
returns the module ID


getModuleType

String getModuleType()
get the module type

Returns:
module type

getFullModuleType

String getFullModuleType()
Get the full module type (including the application prefix)

Returns:
full module type

setModuleType

void setModuleType(String applicationPrefix,
                   String moduleType)
Set the application prefix and portlet name

Parameters:
applicationPrefix - application prefix
moduleType - module type (portlet name)

getPortletRequest

javax.portlet.PortletRequest getPortletRequest()
returns the PortletRequest of this module the portlet request is created when setting the request for this module

Returns:
portlet request

getPortletConfig

javax.portlet.PortletConfig getPortletConfig()
Returns the PortletConfig object of this portlet.

Returns:
the PortletConfig object of this portlet

getGenticsPortletContext

GenticsPortletContext getGenticsPortletContext()
returns the GenticsPortletContext


getPortletContext

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. This Method is NOT within the original JSR 168 interface (javax.portlet.Portlet)


afterProcessAction

void afterProcessAction(javax.portlet.ActionRequest request,
                        javax.portlet.ActionResponse response)

getFileUploadProvider

FileUploadProvider getFileUploadProvider()
Returns:
an instance of FileUploadProvider

returnFileUploadProvider

void returnFileUploadProvider()

getTemplateProcessor

TemplateProcessor getTemplateProcessor(javax.portlet.RenderRequest renderRequest,
                                       javax.portlet.RenderResponse renderResponse)
Deprecated. use GenticsPortletContext.getTemplateProcessor(GenticsPortlet, PortletConfig) instead.

Used to obtain a refence to a template processor to be used for velocity templates.

Parameters:
renderRequest - render request
renderResponse - render response
Returns:
An instance of template processor.

reloadModule

void reloadModule()
This method is called if a module has to be reloaded.


getDatasource

Datasource getDatasource(String id)
get a datasource by id

Parameters:
id - Id of Datasource as defined in portalconfiguration.
Returns:
Datasource corresponding the id.

i18n

I18nString i18n(String key)
get a localized string.

Parameters:
key - the key of the i18n item. the syntax is [a-z0-9.]+, and will generate a warning if violated.
Returns:
the localized string object.


Copyright © 2013 Gentics Software GmbH. All Rights Reserved.