nl.gx.webmanager.wcb
Interface ComponentDefinition

All Known Subinterfaces:

ElementComponentDefinition, FormComponentDefinition, MediaItemComponentDefinition, MenuItemComponentDefinition, PageMetaDataComponentDefinition, PanelComponentDefinition, PresentationComponentDefinition, ServiceComponentDefinition, ServletComponentDefinition

All Known Implementing Classes:

ComponentDefinitionImpl, ElementComponentDefinitionImpl, FormComponentDefinitionImpl, MediaItemComponentDefinitionImpl, MenuItemComponentDefinitionImpl, PageMetaDataComponentDefinitionImpl, PanelComponentDefinitionImpl, PresentationComponentDefinitionImpl, ServiceComponentDefinitionImpl, ServletComponentDefinitionImpl

public interface ComponentDefinition

The definition interface for basic components.

Author:

bramk

Method Summary

ComponentBundleDefinition	getComponentBundleDefinition() Return the component bundle definition.
java.lang.String	getControllerClassName() Returns the fully qualified classname of the controllet class of the component this componentdefinition describes.
ComponentDependency[]	getDependencies() Returns the array of componentdependencies of the component this componentdefinition describes.
java.lang.String	getDescription() Returns the language independent description for the component.
java.lang.String	getDisplayLanguage(java.lang.String resourceName) Return the Java I18N display language assosiated with the resource file used by Spring.
java.lang.String[]	getEntityClassNames() Get the list of classnames that should be handled by the EntityFactory and PersisitenceManager.
java.lang.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
java.lang.String	getId() Returns the unique id for the component.
java.lang.String	getImplementationClassName() Returns the fully qualified classname of the implementing class of the component this componentdefinition describes.
java.lang.String	getInstanceClassName() Return the fully qualified classname of the class returned by the getInstance method the component this componentdefinition describes.
java.lang.String[]	getInterfaceClassNames() Returns the array of fully qualified classnames of the published interfaces for the component this componentdefinition describes.
java.lang.String	getLanguageResourceMessage(java.lang.String messageKey, java.lang.String language)
java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>>	getLanguageResourceMessages() Loads and returns all configured languageResources for this component.
java.lang.String[]	getLanguageResources() Returns the names of the language resource files associated with this component
java.lang.String	getName() Returns the name for the component.
java.lang.String	getNameSpace() Deprecated.
java.lang.String	getNodeType() Returns the unique node type assosiated with the component.
PermissionCategory	getPermissionCategory() Return the permission category assosiated with this component.
java.util.Map<java.lang.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.
java.lang.String	getPersistenceManagerClassName() Get the name of the PersistenceManager class to use for handling persistence of this component.
java.util.Dictionary<java.lang.String,java.lang.String>	getProperties() TODO rename to something like 'context' Returns a dictionary with additional properties for the component this componentdefinition describes.
java.lang.String	getTypeId() Returns the unique id for componenttype of the component this componentdefinition describes.
java.lang.String[]	getWrapperClassNames()
boolean	isLicensed() Returns whether the Component requires a license or not.
void	setComponentBundleDefinition(ComponentBundleDefinition compBundleDef) Set the bundle component definition.
void	setExtensions(ComponentExtension[] extensions) Sets the extensions of the component definition

Method Detail

getId

java.lang.String getId()

Returns the unique id for the component.

Returns:

the id

getName

java.lang.String getName()

Returns the name for the component.

Returns:

the name

getNameSpace

@Deprecated
java.lang.String getNameSpace()

Deprecated.

This method is deprecated. Use the getNameSpace on ComponentBundleDefinitionImpl instead.

getDescription

java.lang.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

java.lang.String getTypeId()

Returns the unique id for componenttype of the component this componentdefinition describes.

Returns:

the typeid

getNodeType

java.lang.String getNodeType()

Returns the unique node type assosiated with the component.

Returns:

the unique node type assosiated with the component

getControllerClassName

java.lang.String getControllerClassName()

Returns the fully qualified classname of the controllet class of the component this componentdefinition describes.

Returns:

the classname

getInterfaceClassNames

java.lang.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

java.lang.String getImplementationClassName()

Returns the fully qualified classname of the implementing class of the component this componentdefinition describes.

Returns:

the classname

getDependencies

ComponentDependency[] getDependencies()

Returns the array of componentdependencies of the component this componentdefinition describes.

Returns:

an array of componentdependencies

getProperties

java.util.Dictionary<java.lang.String,java.lang.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

java.lang.String getInstanceClassName()

Return the fully qualified classname of the class returned by the getInstance method the component this componentdefinition describes.

Returns:

the classname

getLanguageResources

java.lang.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

java.lang.String getDisplayLanguage(java.lang.String resourceName)

Return the Java I18N display language assosiated 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 assosiated with the resource.

getLanguageResourceMessages

java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> getLanguageResourceMessages()

Loads and returns all configured languageResources for this component.

Returns:

a hashtable of loaded languageResources files. Maps the name of the languageresources onto a Hashtable containing the messageKeys and messageValues of that language resource.

getLanguageResourceMessage

java.lang.String getLanguageResourceMessage(java.lang.String messageKey,
                                            java.lang.String language)

Parameters:

label - Label to retrieve from the language resource

language - Language to use

languageResources - Hashtable of language resources of the component

Returns:

message iidentified by the messageKey from the resourcebundle of the provided language.

getWrapperClassNames

java.lang.String[] getWrapperClassNames()

getPermissionCategory

PermissionCategory getPermissionCategory()

Return the permission category assosiated with this component.

Returns:

The permission category assosiated with this component.

getPermissionsForPermissionGroups

java.util.Map<java.lang.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)

Set the bundle component definition.

Parameters:

compBundleDef - Component bundle definition to set

getComponentBundleDefinition

ComponentBundleDefinition getComponentBundleDefinition()

Return the component bundle definition.

Returns:

The component bundle definition.

getEntityFactoryClassName

java.lang.String getEntityFactoryClassName()

Get the name of the EntityFactory class to use for handling persistence of this component.

Returns:

Class name as a string.

getPersistenceManagerClassName

java.lang.String getPersistenceManagerClassName()

Get the name of the PersistenceManager class to use for handling persistence of this component.

Returns:

Class name as a string.

getEntityClassNames

java.lang.String[] getEntityClassNames()

Get 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 -