All Known Subinterfaces:

DojoComponentDefinition, ElementComponentDefinition, FormComponentDefinition, FormFragmentComponentDefinition, FormLogicProviderComponentDefinition, MediaItemComponentDefinition, MenuItemComponentDefinition, PageMetaDataComponentDefinition, PanelComponentDefinition, PresentationComponentDefinition, SearchFacetComponentDefinition, ServiceComponentDefinition, ServletComponentDefinition

All Known Implementing Classes:

ComponentDefinitionImpl, DojoComponentDefinitionImpl, ElementComponentDefinitionImpl, FormComponentDefinitionImpl, MediaItemComponentDefinitionImpl, MenuItemComponentDefinitionImpl, PageMetaDataComponentDefinitionImpl, PanelComponentDefinitionImpl, PresentationComponentDefinitionImpl, ServiceComponentDefinitionImpl, ServletComponentDefinitionImpl
```
public interface ComponentDefinition
```
The definition interface for basic components.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`ComponentBundleDefinition`	`getComponentBundleDefinition()`	Returns the component bundle definition.
`String`	`getControllerClassName()`	Returns the fully qualified className of the controlled class of the component this componentDefinition describes.
`ComponentDependency[]`	`getDependencies()`	Returns the array of componentDependencies of the component this componentDefinition describes.
`String`	`getDescription()`	Returns the language independent description for the component.
`String`	`getDisplayLanguage(String resourceName)`	Return the Java I18N display language associated with the resource file used by Spring.
`String[]`	`getEntityClassNames()`	Gets the list of classNames that should be handled by the EntityFactory and PersisitenceManager.
`String`	`getEntityFactoryClassName()`	Get the name of the EntityFactory class to use for handling persistence of this component.
`ComponentExtension[]`	`getExtensions()`	Returns a list of component extensions of the component definition.
`String`	`getId()`	Returns the unique id for the component.
`String`	`getImplementationClassName()`	Returns the fully qualified className of the implementing class of the component this componentDefinition describes.
`Object`	`getImplementationInstance()`	Returns the instance of the implementing class of the component this ComponentDefinition describes.
`String`	`getInstanceClassName()`	Return the fully qualified className of the class returned by the getInstance method the component this componentDefinition describes.
`String[]`	`getInterfaceClassNames()`	Returns the array of fully qualified classNames of the published interfaces for the component this componentDefinition describes.
`String`	`getLanguageResourceMessage(String messageKey, String language)`
`HashMap<String,HashMap<String,String>>`	`getLanguageResourceMessages()`	Loads and returns all configured languageResources for this component.
`String[]`	`getLanguageResources()`	Returns the names of the language resource files associated with this component
`String`	`getName()`	Returns the name for the component.
`String`	`getNameSpace()`	Deprecated.
`String`	`getNodeType()`	Returns the unique node type associated with the component.
`PermissionCategory`	`getPermissionCategory()`	Returns the permission category associated with this component.
`Map<String,Permission[]>`	`getPermissionsForPermissionGroups()`	Returns a mapping that maps for each permission group which permissions used in this component should be assigned to that permission group.
`String`	`getPersistenceManagerClassName()`	Get the name of the PersistenceManager class to use for handling persistence of this component.
`Dictionary<String,String>`	`getProperties()`	TODO rename to something like 'context' Returns a dictionary with additional properties for the component this componentDefinition describes.
`String`	`getTypeId()`	Returns the unique id for componentType of the component this componentDefinition describes.
`String[]`	`getWrapperClassNames()`
`boolean`	`isLicensed()`	Returns whether the `Component` requires a license or not.
`void`	`setComponentBundleDefinition(ComponentBundleDefinition compBundleDef)`	Sets the bundle component definition.
`void`	`setExtensions(ComponentExtension[] extensions)`	Sets the extensions of the component definition.

- Method Detail
  - getId
```
String getId()
```
    Returns the unique id for the component.
    
    Returns:
    
    the id
  - getName
```
String getName()
```
    Returns the name for the component.
    
    Returns:
    
    the name
  - getNameSpace
```
@Deprecated
String getNameSpace()
```
    Deprecated.
    
    This method is deprecated. Use the getNameSpace on ComponentBundleDefinitionImpl instead.
  - getDescription
```
String getDescription()
```
    Returns the language independent description for the component.
    
    Returns:
    
    language independent description for the component
  - isLicensed
```
boolean isLicensed()
```
    Returns whether the Component requires a license or not.
    
    Returns:
    
    If TRUE, the component requires a license to run in Web Manager.
  - getTypeId
```
String getTypeId()
```
    Returns the unique id for componentType of the component this componentDefinition describes.
    
    Returns:
    
    the typeId
  - getNodeType
```
String getNodeType()
```
    Returns the unique node type associated with the component.
    
    Returns:
    
    the unique node type associated with the component
  - getControllerClassName
```
String getControllerClassName()
```
    Returns the fully qualified className of the controlled class of the component this componentDefinition describes.
    
    Returns:
    
    the className
  - getInterfaceClassNames
```
String[] getInterfaceClassNames()
```
    Returns the array of fully qualified classNames of the published interfaces for the component this componentDefinition describes.
    
    Returns:
    
    an array of interfaceClassNames
  - getImplementationClassName
```
String getImplementationClassName()
```
    Returns the fully qualified className of the implementing class of the component this componentDefinition describes.
    
    Returns:
    
    the className
  - getImplementationInstance
```
Object getImplementationInstance()
```
    Returns the instance of the implementing class of the component this ComponentDefinition describes. This is the instance of the service that is described by this component definition. This instance returns an implementation of the class with name getImplementationClassName(), thus the class name of the object returned here equals, if not null, the implementation class name.
    
    Returns:
    
    The instance of the component
  - getDependencies
```
ComponentDependency[] getDependencies()
```
    Returns the array of componentDependencies of the component this componentDefinition describes.
    
    Returns:
    
    an array of componentDependencies
  - getProperties
```
Dictionary<String,String> getProperties()
```
    TODO rename to something like 'context' Returns a dictionary with additional properties for the component this componentDefinition describes.
    
    Returns:
    
    a dictionary of properties
  - getInstanceClassName
```
String getInstanceClassName()
```
    Return the fully qualified className of the class returned by the getInstance method the component this componentDefinition describes.
    
    Returns:
    
    the className
  - getLanguageResources
```
String[] getLanguageResources()
```
    Returns the names of the language resource files associated with this component
    
    Returns:
    
    the names of the language resource files associated with this component
  - getDisplayLanguage
```
String getDisplayLanguage(String resourceName)
```
    Return the Java I18N display language associated with the resource file used by Spring.
    
    Parameters:
    
    resourceName - Name of the resource file. Syntax of this file must be messages__.properties
    
    Returns:
    
    Java locale display language name associated with the resource.
  - getLanguageResourceMessages
```
HashMap<String,HashMap<String,String>> getLanguageResourceMessages()
```
    Loads and returns all configured languageResources for this component.
    
    Returns:
    
    a hashMap of loaded languageResources files. Maps the name of the languageresources onto a hashMap containing the messageKeys and messageValues of that language resource.
  - getLanguageResourceMessage
```
String getLanguageResourceMessage(String messageKey,
                                  String language)
```
    Parameters:
    
    language - Language to use
    
    Returns:
    
    message identified by the messageKey from the resourceBundle of the provided language.
  - getWrapperClassNames
```
String[] getWrapperClassNames()
```
  - getPermissionCategory
```
PermissionCategory getPermissionCategory()
```
    Returns the permission category associated with this component.
    
    Returns:
    
    The permission category associated with this component.
  - getPermissionsForPermissionGroups
```
Map<String,Permission[]> getPermissionsForPermissionGroups()
```
    Returns a mapping that maps for each permission group which permissions used in this component should be assigned to that permission group. Permission groups are identified by a uniquely identifying string.
    
    Returns:
    
    a mapping that maps for each permission group which permissions used in this component should be assigned to that permission group
  - setComponentBundleDefinition
```
void setComponentBundleDefinition(ComponentBundleDefinition compBundleDef)
```
    Sets the bundle component definition.
    
    Parameters:
    
    compBundleDef - Component bundle definition to set
  - getComponentBundleDefinition
```
ComponentBundleDefinition getComponentBundleDefinition()
```
    Returns the component bundle definition.
    
    Returns:
    
    The component bundle definition.
  - getEntityFactoryClassName
```
String getEntityFactoryClassName()
```
    Get the name of the EntityFactory class to use for handling persistence of this component.
    
    Returns:
    
    Class name as a string.
  - getPersistenceManagerClassName
```
String getPersistenceManagerClassName()
```
    Get the name of the PersistenceManager class to use for handling persistence of this component.
    
    Returns:
    
    Class name as a string.
  - getEntityClassNames
```
String[] getEntityClassNames()
```
    Gets the list of classNames that should be handled by the EntityFactory and PersisitenceManager.
    
    Returns:
    
    an Array containing names of Entity classes
  - getExtensions
```
ComponentExtension[] getExtensions()
```
    Returns a list of component extensions of the component definition.
    
    Returns:
    
    List of component extensions
  - setExtensions
```
void setExtensions(ComponentExtension[] extensions)
```
    Sets the extensions of the component definition.
    
    Parameters:
    
    extensions -

Interface ComponentDefinition

Method Summary

Method Detail

getId

getName

getNameSpace

getDescription

isLicensed

getTypeId

getNodeType

getControllerClassName

getInterfaceClassNames

getImplementationClassName

getImplementationInstance

getDependencies

getProperties

getInstanceClassName

getLanguageResources

getDisplayLanguage

getLanguageResourceMessages

getLanguageResourceMessage

getWrapperClassNames

getPermissionCategory

getPermissionsForPermissionGroups

setComponentBundleDefinition

getComponentBundleDefinition

getEntityFactoryClassName

getPersistenceManagerClassName

getEntityClassNames

getExtensions

setExtensions