IComponentData (server-common-api)

All Known Subinterfaces:

IBizPolicyData, IHandlerData, IMechanicsData, IPortletInfo, IThingComponentData

All Known Implementing Classes:

OsgiServiceComponentData
```
public interface IComponentData
```
The IComponentData implements the storage for an IComponent. This relieves the IComponent from having to persist its own metadata, and provides a separation from the management of that metadata and the actual implementation of the IComponent.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IComponent`	`getComponent()` A factory method to create the component from this IComponentData.
`String`	`getComponentClassName()` Gets the classname for the `IComponent` which can be used in calls to `ObjectUtil.createObject(java.lang.String)`.
`Element`	`getConfig()` Gets the config element for this `IComponent`.
`String`	`getConfigFile()` Get `configFile` attribute value.
`String`	`getConfigStream()` Gets config data as raw String stream
`boolean`	`getEnabled()` Gets whether this `IComponent` is enabled or not.
`Map<String,Object>`	`getProperties()` Gets the properties for this `IComponent`.
`IURI`	`getURI()`
`void`	`setComponent(IComponent component)` If for some reason you want to create and initialize an `IComponent` externally Use only with caution, or not at all.
`void`	`setComponentClassName(String className)` Sets the implementation class name for the `IComponent`.
`void`	`setConfig(Element configElement)` Sets the config element for this `IComponent`.
`void`	`setConfigFile(String configFile)` Set the value of `configFile`
`void`	`setConfigStream(String config)` Sets component data as raw String stream
`void`	`setEnabled(boolean enabled)` Sets whether this `IComponent` is enabled
`DifferenceMap`	`setProperties(Map<String,? extends Object> properties)` Sets the properties for this `IComponent`.

- Method Detail
  - getURI
```
IURI getURI()
     throws PortalException
```
    Returns:
    
    a unique URI which describes this IComponentData
    
    Throws:
    
    PortalException
  - getComponentClassName
```
String getComponentClassName()
                      throws PortalException
```
    Gets the classname for the IComponent which can be used in calls to ObjectUtil.createObject(java.lang.String).
    
    Returns:
    
    a valid string for calls to ObjectUtil.createObject(java.lang.String).
    
    Throws:
    
    PortalException
  - setComponentClassName
```
void setComponentClassName(String className)
                    throws PortalException
```
    Sets the implementation class name for the IComponent.
    
    Parameters:
    
    className - a valid string for calls to ObjectUtil.createObject(java.lang.String).
    
    Throws:
    
    PortalException
  - getEnabled
```
boolean getEnabled()
            throws PortalException
```
    Gets whether this IComponent is enabled or not.
    
    Returns:
    
    true if enabled, false otherwise
    
    Throws:
    
    PortalException
  - setEnabled
```
void setEnabled(boolean enabled)
         throws PortalException
```
    Sets whether this IComponent is enabled
    
    Parameters:
    
    enabled -
    
    Throws:
    
    PortalException
  - getConfig
```
Element getConfig()
           throws PortalException
```
    Gets the config element for this IComponent.
    
    Returns:
    
    Either the config element, or NULL if it is properties based
    
    Throws:
    
    PortalException
  - setConfig
```
void setConfig(Element configElement)
        throws PortalException
```
    Sets the config element for this IComponent.
    
    Parameters:
    
    configElement -
    
    Throws:
    
    PortalException
  - getConfigStream
```
String getConfigStream()
                throws PortalException
```
    Gets config data as raw String stream
    
    Returns:
    
    Throws:
    
    PortalException
  - setConfigStream
```
void setConfigStream(String config)
              throws PortalException
```
    Sets component data as raw String stream
    
    Parameters:
    
    config -
    
    Throws:
    
    PortalException
  - getProperties
```
Map<String,Object> getProperties()
                          throws PortalException
```
    Gets the properties for this IComponent.
    
    Returns:
    
    properties, or simple Element attributes if this is element based
    
    Throws:
    
    PortalException
  - setProperties
```
DifferenceMap setProperties(Map<String,? extends Object> properties)
                     throws PortalException
```
    Sets the properties for this IComponent.
    
    Parameters:
    
    properties -
    
    Throws:
    
    PortalException
  - getComponent
```
IComponent getComponent()
                 throws PortalException
```
    A factory method to create the component from this IComponentData. This will also initialize the IComponent if it hasn't already been initialized
    
    Returns:
    
    an initialized IComponent
    
    Throws:
    
    PortalException
  - setComponent
```
void setComponent(IComponent component)
```
    If for some reason you want to create and initialize an IComponent externally Use only with caution, or not at all.
    
    Parameters:
    
    component - a valid IComponent.
  - getConfigFile
```
String getConfigFile()
              throws PortalException
```
    Get configFile attribute value.
    
    Throws:
    
    PortalException
    
    See Also:
    
    getConfig()
  - setConfigFile
```
void setConfigFile(String configFile)
            throws PortalException
```
    Set the value of configFile
    
    Parameters:
    
    configFile -
    
    Throws:
    
    PortalException

Interface IComponentData

Method Summary

Method Detail

getURI

getComponentClassName

setComponentClassName

getEnabled

setEnabled

getConfig

setConfig

getConfigStream

setConfigStream

getProperties

setProperties

getComponent

setComponent

getConfigFile

setConfigFile