SAP NetWeaver '04

com.sapportals.wcm.crt.component
Interface IComponentManager

[contained in: com.sap.netweaver.bc.crt.par - bc.crt_api.jar]
All Known Subinterfaces:
IContainerManager

public interface IComponentManager

A component manager manages all root components of a CRT client or all components within a container component. Components are identified by a key.

Copyright (c) SAP AG 2001-2002


Method Summary
 boolean hasComponent(java.lang.String key)
          Returns true if the component with the specified key exists.
 java.lang.String[] listComponentKeys()
          Returns an array of the keys of all components contained in this manager.
 IComponent lookupComponent(java.lang.String key)
          Returns the component instance for the specified key or null if the component was not found.
 void releaseComponent(IComponent component)
          Releases the component.
 

Method Detail

lookupComponent

public IComponent lookupComponent(java.lang.String key)
                           throws ComponentException
Returns the component instance for the specified key or null if the component was not found.
Parameters:
key - The component key to look for. Keys are case-sensitive.

The caller must subseqently call releaseComponent() when it is finished using the component. This is optional for thread-safe components.

Returns:
the component instance.
Throws:
ComponentException - If the component could not be instanciated.

hasComponent

public boolean hasComponent(java.lang.String key)
Returns true if the component with the specified key exists.
Parameters:
key - The component key to look for. Keys are case-sensitive.
Returns:
True if the component exists.

releaseComponent

public void releaseComponent(IComponent component)
Releases the component. This method should be called when the caller is finished using the component. It must be called for all components that do not implement the IThreadSafe interface - it is optional for thread-safe components.
Parameters:
component - A reference to the component to release.

listComponentKeys

public java.lang.String[] listComponentKeys()
Returns an array of the keys of all components contained in this manager.
Returns:
An array of the keys of all components contained in this manager.

SAP NetWeaver '04

Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.