com.ibm.workplace.wcm.api
Interface ContentComponent

All Known Subinterfaces:

DateComponent, DocumentManagerComponent, FileComponent, HTMLComponent, ImageComponent, LinkComponent, NumericComponent, OptionSelectionComponent, ReferenceComponent, RichTextComponent, TextComponent, UserSelectionComponent

public interface ContentComponent

The root interface in the Content Component hierarchy. ContentComponent is an interface to mark a component that can be held within a ContentComponentContainer.

A ContentComponent can exist only on Content, Site or SiteArea objects. A ContentComponent must live in a ContentComponentContainer - it cannot exist in the the repository as a separate object.

A content component has a one-to-one relationship with a ContentComponentContainer object, and consequently, with an object that can implements a ContentComponentContainer. This is different to a LibraryComponent as a LibraryComponent may be reused by different objects in the repository.

note: since v6.0.0, a ContentComponent is referred to as an "Element" in the Authoring UI.

See Also:

LibraryComponent

Method Summary

com.ibm.workplace.wcm.api.ContentComponentContainer	getContainer() Returns the ContentComponentContainer object that contains this ContentComponent.
java.lang.String	getName() Returns the name of this ContentComponent object.

Method Detail

getName

public java.lang.String getName()

Returns the name of this ContentComponent object.

Returns:

the component name

getContainer

public com.ibm.workplace.wcm.api.ContentComponentContainer getContainer()

Returns the ContentComponentContainer object that contains this ContentComponent.

Returns:

the ContentComponentContainer of this object

Throws:

java.lang.IllegalStateException - if the ContentComponentContainer for this ContentComponent has not been set