com.ibm.workplace.wcm.api
Interface ContentTemplateItemProperties

All Superinterfaces:

AbstractTemplateItemProperties

public interface ContentTemplateItemProperties
extends AbstractTemplateItemProperties

The item properties for a content template.

Field Summary

Fields inherited from interface com.ibm.workplace.wcm.api.AbstractTemplateItemProperties

DEFAULT_PRESENTATION_IDENTIFIER, SUMMARY_PRESENTATION_IDENTIFIER

Method Summary

TargetableContentComponent	getTargetComponent() Returns the TargetableContentComponent that has been set on this authoring template.
void	setTargetComponent(TargetableContentComponent target) Sets the TargetableContentComponent as the target component for this AuthoringTemplate.

Methods inherited from interface com.ibm.workplace.wcm.api.AbstractTemplateItemProperties

getAllSupportedRenderModes, getDefaultPresentationTemplate, getPresentationTemplateForMode, getPresentationTemplateForModes, getPreviewImage, getRenderModesForPresentationTemplate, hasPresentationTemplateForMode, hasPreviewImage, isWorkflowEnabled, removeRenderMode, setDefaultPresentationTemplate, setPresentationTemplateForMode, setWorkflowEnabled

Method Detail

getTargetComponent

TargetableContentComponent getTargetComponent()

Returns the TargetableContentComponent that has been set on this authoring template. If the the TargetableContentComponent hasn't been set then null will be returned.

Returns:

a copy of the current target component

setTargetComponent

void setTargetComponent(TargetableContentComponent target)
                        throws com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException,
                               com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException

Sets the TargetableContentComponent as the target component for this AuthoringTemplate. Passing a null argument to clear target component.

The target component controls the behavior of Content subsequently created by this template when rendered within a Menu, Navigator or by a Link Component.

If the target component is LinkComponent or FileComponent then all links rendered to the that Content item will be directed towards the TargetableContentComponent. E.g. If the target component is FileComponent then all links to that content item will by default render as links to the embedded file resource TargetableContentComponent.

Parameters:

target - A TargetableContentComponent should already created in ContentPrototype.

Throws:

com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException - if the given TargetableContentComponent doesn't exist in ContentPrototype

com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException - if the ContentComponent passed in as an argument is a different type than the existing component