|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GenticsPlugin
The GenticsPlugin defines the API of plugins. Plugins provide functionality that can easily be (re-)used inside any Gentics portlet.
Method Summary | |
---|---|
void |
afterProcessAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse response)
This method is called by the portal after calling Portlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)
on this plugin. |
EventBroker |
getEventBroker()
returns the current event broker |
FileUploadProvider |
getFileUploadProvider()
Get the file upload provider. |
String |
getFullPluginName()
Get the full plugin name (including the portletapplication prefix) |
GenticsPortlet |
getModule()
Get the module which registeres and uses this plugin |
void |
returnFileUploadProvider()
Return the file upload provider which was fetched via getFileUploadProvider() before |
void |
setEventBrokerProvider(EventBrokerProvider eventBrokerProvider)
Set the event broker provider |
void |
setId(String id)
Set the id of the plugin. |
void |
setModule(GenticsPortlet module)
Set the module which registeres and uses this plugin. |
void |
setPluginName(String applicationPrefix,
String pluginName)
Set the plugin name |
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 javax.portlet.Portlet |
---|
destroy, init, processAction, render |
Methods inherited from interface javax.portlet.PortletConfig |
---|
getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales |
Method Detail |
---|
void setEventBrokerProvider(EventBrokerProvider eventBrokerProvider)
eventBrokerProvider
- EventBroker getEventBroker()
void setModule(GenticsPortlet module)
AbstractGenticsPortlet.registerPlugin(String, GenticsPlugin)
and need not be called from outside.
module
- module using this pluginGenticsPortlet getModule()
void setId(String id)
id
- id of the pluginvoid afterProcessAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
Portlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)
on this plugin. The plugin implementation of this method may do some
cleanup after processing the action.
request
- action requestresponse
- action responseFileUploadProvider getFileUploadProvider()
void returnFileUploadProvider()
getFileUploadProvider()
before
String getFullPluginName()
void setPluginName(String applicationPrefix, String pluginName)
applicationPrefix
- application prefixpluginName
- plugin name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |