com.gentics.api.portalnode.imp
Interface GenticsImpInterface

All Known Subinterfaces:
GenticsStatefulImpInterface
All Known Implementing Classes:
AbstractGenticsImp

public interface GenticsImpInterface

interface for small imps that are available in dungeons, modules, templates, ... If the imp stores any private data which is not threadsafe (i.e. can be modified while using the imp), the GenticsStatefulImpInterface must be used.

Author:
norbert

Method Summary
 java.lang.String getImpId()
          get the id of the imp by which it has been initialized.
 void init(java.lang.String impId, java.util.Map parameters)
          initialize the imp with the parameters defined in the <parameters> tag of the imp.
 

Method Detail

init

void init(java.lang.String impId,
          java.util.Map parameters)
          throws ImpException
initialize the imp with the parameters defined in the <parameters> tag of the imp. Init is called before any other parameters are set and is called only once when the imp is created, not when the imp is reused.

Parameters:
impId - the configured id of the imp, must be returned by getImpId()
parameters - configuration of the imp
Throws:
ImpException - if errors occured

getImpId

java.lang.String getImpId()
get the id of the imp by which it has been initialized.

Returns:
the id if this configured imp.


Copyright © 2013 Gentics Software GmbH. All Rights Reserved.