org.hippoecm.hst.configuration.components
Interface HstComponentInfo

All Known Subinterfaces:

HstComponentConfiguration

All Known Implementing Classes:

DelegatingHstComponentInfo, HstComponentConfigurationService, MockHstComponentConfiguration

public interface HstComponentInfo

HstComponentConfiguration.

Basic information interface for component configuration.

Version:

$Id: HstComponentInfo.java 30330 2011-09-20 16:10:30Z aschrijvers $

See Also:

HstComponentConfiguration}

Method Summary

String	getComponentClassName()
String	getId() Returns the id for this component configuration.
String	getName() Return the name of this component configuration.
boolean	isStandalone()

Method Detail

getId

String getId()

Returns the id for this component configuration. The id must be unique within the container HstComponentsConfiguration, or null if it is not needed to be directly accessed by the HstComponentsConfiguration through HstComponentsConfiguration.getComponentConfiguration(String). Every HstComponentConfiguration that can be referred to from within a HstSiteMapItem must have an id.

Returns:

the id of this component configuration or null if no id set

getName

String getName()

Return the name of this component configuration. It must be unique amongst siblings. The value returned by this method, is the value that must be used in rendering code (jsp/velocity/freemarker) to include the output of a child HstComponent instance.

Returns:

the logical name this component configuration, unique amongst its siblings

getComponentClassName

String getComponentClassName()

Returns:

the fully-qualified class name of the class implementing the HstComponent interface

isStandalone

boolean isStandalone()

Returns:

true when this HstComponentConfiguration is configured to be rendered standalone in case of HstURL.COMPONENT_RENDERING_TYPE