com.filenet.wcm.toolkit.server.base

Class WcmDpContainer

  1. java.lang.Object
  2. extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
Direct known subclasses:
WcmController, WcmModule
  1. public class WcmDpContainer
  2. extends java.lang.Object
WcmDpContainer provides data provider binding functionality for any classes that derive from it. Accessing bound data providers is accomplished inside of a UI or DP module by calling queryDataProvider(String type).

Constructor Summary

Constructor and Description
WcmDpContainer()

Method Summary

Modifier and Type Method and Description
  1. void
 addDataProvider(WcmDpModuleInterface dp)
Associate an instance of a data provider with this module.
  1. void
 addDataProvider(WcmDpModuleInterface dp,java.lang.Class superClass)
Associate an instance of a data provider with this module.
  1. WcmDpModuleInterface
 queryDataProvider(java.lang.String type)
Query for an associated data provider (added with addDataProvider) of the specified type.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WcmDpContainer

  1. public WcmDpContainer()

Method Detail

addDataProvider

  1. public void addDataProvider(WcmDpModuleInterface dp)
Associate an instance of a data provider with this module. The data providers are keyed by their class name.
Parameters:
dp - A reference to a data provider.

addDataProvider

  1. public void addDataProvider(WcmDpModuleInterface dp,
  2. java.lang.Class superClass)
  3. throws java.lang.Exception
Associate an instance of a data provider with this module. Typically a data provider is keyed by its class name, but this call allows the specification of a superclass to reference for the class name. The data provider passed in is tested to confirm instanceof the specified superclass. If valid, the data provider is bound using the superclass name instead of its own class name.
Parameters:
dp -
superClass -
Throws:
java.lang.Exception

queryDataProvider

  1. public WcmDpModuleInterface queryDataProvider( java.lang.String type)
Query for an associated data provider (added with addDataProvider) of the specified type.
Parameters:
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.
Returns:
An instance of the data provider if found, otherwise null.