Skip navigation links

oracle.stellent.wcm.core.project.structure
Class Placeholder

java.lang.Object
oracle.stellent.wcm.core.project.structure.Placeholder

All Implemented Interfaces:

java.lang.Cloneable

public class Placeholder

extends java.lang.Object

implements java.lang.Cloneable

Nested Class Summary

static class

Placeholder.Origin

Field Summary

protected java.util.Map<java.lang.String,java.lang.String>

m_properties

Constructor Summary

Placeholder()

Placeholder(java.lang.String name, java.lang.String template, java.lang.String dataFile)

Method Summary

Placeholder	clone()
java.lang.String	getDataFile()
Placeholder.Origin	getDataFileOrigin()
PlaceholderDefinition	getDefinitionObject()
java.lang.String	getName()
java.lang.String	getPlaceholderDefinition()
Placeholder.Origin	getPlaceholderDefinitionOrigin()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.lang.String	getProperty(java.lang.String name) Retrieve an arbitrary property from this section content.
java.lang.String	getRegionDefinition()
Placeholder.Origin	getRegionDefinitionOrigin()
java.lang.String	getTemplate()
Placeholder.Origin	getTemplateOrigin()
java.lang.String	getTemplateType()
boolean	isNativeDocument()
boolean	isPlaceholderRegion()
void	setDataFile(java.lang.String dataFile)
void	setDataFileOrigin(Placeholder.Origin dataFileOrigin)
void	setDefinitionObject(PlaceholderDefinition definitionObject)
void	setName(java.lang.String name)
void	setNativeDocument(boolean m_nativeDocument)
void	setPlaceholderDefinition(java.lang.String placeholderDefinition)
void	setPlaceholderDefinitionOrigin(Placeholder.Origin placeholderDefinitionOrigin)
void	setProperty(java.lang.String name, java.lang.String value) Set a property into this section
void	setRegionDefinition(java.lang.String regionDefinition)
void	setRegionDefinitionOrigin(Placeholder.Origin regionDefinitionOrigin)
void	setTemplate(java.lang.String template)
void	setTemplateOrigin(Placeholder.Origin templateOrigin)
void	setTemplateType(java.lang.String templateType)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_properties

protected java.util.Map<java.lang.String,java.lang.String> m_properties

Constructor Detail

Placeholder

public Placeholder()

Placeholder

public Placeholder(java.lang.String name,
                   java.lang.String template,
                   java.lang.String dataFile)

Method Detail

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns:

the properties contained within this content

getProperty

public java.lang.String getProperty(java.lang.String name)

Retrieve an arbitrary property from this section content. Shortcut to calling getProperties ().get("property").

Parameters:

name - the property name

Returns:

the property value

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Set a property into this section

Parameters:

name - the property name

value - the property value

getName

public java.lang.String getName()

Returns:

the name of this content item

setName

public void setName(java.lang.String name)

getTemplate

public java.lang.String getTemplate()

Returns:

the view content ID

setTemplate

public void setTemplate(java.lang.String template)

getTemplateType

public java.lang.String getTemplateType()

Returns:

the type of view

setTemplateType

public void setTemplateType(java.lang.String templateType)

getTemplateOrigin

public Placeholder.Origin getTemplateOrigin()

Returns:

the origin of the view

setTemplateOrigin

public void setTemplateOrigin(Placeholder.Origin templateOrigin)

getPlaceholderDefinition

public java.lang.String getPlaceholderDefinition()

Returns:

the name of the placeholder config

setPlaceholderDefinition

public void setPlaceholderDefinition(java.lang.String placeholderDefinition)

getPlaceholderDefinitionOrigin

public Placeholder.Origin getPlaceholderDefinitionOrigin()

Returns:

the origin of the placeholder config

setPlaceholderDefinitionOrigin

public void setPlaceholderDefinitionOrigin(Placeholder.Origin placeholderDefinitionOrigin)

getDefinitionObject

public PlaceholderDefinition getDefinitionObject()

Returns:

the definition object used to build this placeholder

setDefinitionObject

public void setDefinitionObject(PlaceholderDefinition definitionObject)

isPlaceholderRegion

public boolean isPlaceholderRegion()

Returns:

true if this region was defined by a placeholder (i.e. its information came from the project.xml file); false if this is a static region

getDataFile

public java.lang.String getDataFile()

Returns:

the datafile content ID

setDataFile

public void setDataFile(java.lang.String dataFile)

getDataFileOrigin

public Placeholder.Origin getDataFileOrigin()

Returns:

the origin of the data file

setDataFileOrigin

public void setDataFileOrigin(Placeholder.Origin dataFileOrigin)

getRegionDefinition

public java.lang.String getRegionDefinition()

setRegionDefinition

public void setRegionDefinition(java.lang.String regionDefinition)

getRegionDefinitionOrigin

public Placeholder.Origin getRegionDefinitionOrigin()

setRegionDefinitionOrigin

public void setRegionDefinitionOrigin(Placeholder.Origin regionDefinitionOrigin)

isNativeDocument

public boolean isNativeDocument()

setNativeDocument

public void setNativeDocument(boolean m_nativeDocument)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public Placeholder clone()

Overrides:

clone in class java.lang.Object

Returns:

a copy of this object

Skip navigation links