|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
WcmModuleInterface is the base for all modules, and defines methods that are common to all modules.
Method Summary | |
void |
addDataProvider(WcmDpModuleInterface dp)
Associate an instance of a data provider with this module. |
void |
cleanup()
Called by WcmController after persist(), when it's about to go to another JSP page. |
WcmDataStore |
getDataStore()
Get the data store object. |
java.lang.Object |
getModuleProperty(java.lang.String key)
Get a module-scoped property from the Data Store. |
java.lang.String |
getName()
Get the unique name for this module. |
WcmModuleInterface |
getParent()
Get the module's parent if this is a contained module. |
void |
initialize()
Called by WcmController when the module is registered, and has access to the data store. |
void |
persist()
Called by WcmController before cleanup(), when it's about to go to another Java™Server Pages (JSP) page. |
WcmDpModuleInterface |
queryDataProvider(java.lang.String type)
Query for a data provider of the specified type. |
void |
setController(WcmController c)
Called by WcmController as part of module registration/un-registration. |
void |
setModuleProperty(java.lang.String key,
java.lang.Object value)
Set a module-scoped property in the data store. |
void |
setName(java.lang.String value)
Set the unique name for this module. |
void |
setParent(WcmModuleInterface m)
Set the specified module as the parent of this module. |
Method Detail |
public void persist() throws java.lang.Exception
java.lang.Exception
public void cleanup() throws java.lang.Exception
java.lang.Exception
public void initialize() throws java.lang.Exception
java.lang.Exception
public void setName(java.lang.String value) throws java.lang.Exception
value
- The name value.
WcmException
- toolkit.WcmModule.nameInvalid, if the name contains the illegal characters NAME_DELIMITER or ( . ).
java.lang.Exception
public java.lang.String getName()
WcmException
- toolkit.WcmModule.nameInvalid, if the name contains the illegal characters NAME_DELIMITER or ( . ).public void addDataProvider(WcmDpModuleInterface dp)
dp
- A reference to a data provider.public WcmDpModuleInterface queryDataProvider(java.lang.String type)
type
- The type name for the data provider. All data providers should follow the convention of providing a public static final TYPE that can be passed here.
public void setModuleProperty(java.lang.String key, java.lang.Object value) throws java.lang.Exception
key
- The key name to use.value
- The value to set. null is valid, and clears the key.
WcmException
- (toolkit.WcmModule.setModulePropertyNullKey)
WcmException
- (toolkit.WcmModule.dataStoreUndefined)
java.lang.Exception
public java.lang.Object getModuleProperty(java.lang.String key) throws java.lang.Exception
key
- The key name to use.
WcmException
- (toolkit.WcmModule.getModulePropertyNullKey)
WcmException
- (toolkit.WcmModule.dataStoreUndefined)
java.lang.Exception
public WcmDataStore getDataStore() throws java.lang.Exception
WcmException
- (toolkit.WcmModule.moduleNotRegistered)
WcmException
- (toolkit.WcmModule.dataStoreUndefined)
java.lang.Exception
public void setParent(WcmModuleInterface m) throws java.lang.Exception
m
- The module that is to be this module's parent.
WcmException
- (toolkit.WcmModule.setParentAlreadyRegistered)
java.lang.Exception
public WcmModuleInterface getParent()
java.lang.Exception
public void setController(WcmController c) throws java.lang.Exception
WcmException
- (toolkit.wcmModule.setControllerOnUnregisteredModule)
WcmException
- (toolkit.wcmModule.setControllerRegisteredModule)
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |