Skip navigation links

oracle.stellent.wcm.core.definition.placeholder
Class PlaceholderDefinition

java.lang.Object
oracle.stellent.wcm.core.definition.placeholder.PlaceholderDefinition

public class PlaceholderDefinition

extends java.lang.Object

A placeholder definition that defines what is allowed in a placeholder along with default data to render the placeholder.

Nested Class Summary

static class

PlaceholderDefinition.Action

Field Summary

static java.lang.String	APPROVE
static java.lang.String	DOC_INFO
static java.lang.String	DOC_INFO_UPDATE
static java.lang.String	MODIFY_METADATA
static java.lang.String	PREVIEW
static java.lang.String	REJECT
static java.lang.String	REMOVE_ASSOCIATION
static java.lang.String	RESET
static java.lang.String	SWITCH_DATA_FILE
static java.lang.String	SWITCH_REGION_TEMPLATE
static java.lang.String	UPDATE
static java.lang.String	VIEW_TRACKER_REPORT
static java.lang.String	VIEW_USAGE_REPORT

Constructor Summary

PlaceholderDefinition()
Create an empty placeholder definition

PlaceholderDefinition(oracle.stellent.wcm.core.definition.placeholder.model.PlaceholderDefinitionType model)
Create a placeholder definition with the supplied properties and region schema view mapping

Method Summary

void	addRegionDefinition(java.lang.String definitionName) Add a region definition reference to this placeholder config
void	addRegionTemplate(java.lang.String regionDefinition, java.lang.String template) Add a region definition to template mapping
void	addRegionTemplate(java.lang.String definitionName, java.lang.String templateName, boolean isDefault) Add a region definition to template mapping
void	addSubtemplate(java.lang.String contentID) Add the subtemplate to the list
boolean	containsRegionDefinition(java.lang.String definitionName) Determine if the given definitionName is mapped in this placeholder
boolean	containsRegionTemplate(java.lang.String definitionName, java.lang.String templateName) Determine if the region template is mapped to this definition
boolean	containsSubtemplate(java.lang.String templateName) Determine if the given subtemplate is in this placeholder
java.lang.String	getDefaultRegionTemplate(java.lang.String definitionName) Retrieve the default region template for the given definition
java.lang.String	getDescription()
java.util.Map<java.lang.String,java.lang.Boolean>	getFlagMap() Retrieve the actions settings as a map of action to boolean
protected oracle.stellent.wcm.core.definition.placeholder.model.ComplexProperty	getFlagsProperty()
oracle.stellent.wcm.core.definition.placeholder.model.PlaceholderDefinitionType	getModel()
protected oracle.stellent.wcm.core.definition.placeholder.model.Property	getProperty(java.lang.String name)
java.util.Collection<java.lang.String>	getRegionDefinitionNames()
protected oracle.stellent.wcm.core.definition.placeholder.model.RegionDefinitionType	getRegionDefinitionType(java.lang.String definitionName)
java.util.List<java.lang.String>	getRegionTemplates(java.lang.String definitionName) Retrieve the region views for the given definition name
java.util.List<java.lang.String>	getSubtemplates()
protected oracle.stellent.wcm.core.definition.placeholder.model.SubTemplateType	getSubtemplateType(java.lang.String contentID)
boolean	isActionSet(PlaceholderDefinition.Action action) Determine if the given action is set
boolean	isEmpty()
void	merge(PlaceholderDefinition placeholderDefinition) Merge the given placeholder definition into this definition
void	removeAction(PlaceholderDefinition.Action action) Remove an action from this definition
void	removeActions() Remove all the actions on this placeholder definition
void	removeRegionDefinition(java.lang.String definitionName) Remove the region definition and all associated templates
void	removeRegionTemplate(java.lang.String definitionName, java.lang.String templateName) Remove the region template view
void	removeSubtemplate(java.lang.String contentID) Remove a subtemplate from the list of available templates
void	setAction(PlaceholderDefinition.Action action, boolean value) Set the action to the given value
void	setDefaultRegionTemplate(java.lang.String regionDefinition, java.lang.String template) Set a template to be the default for a given definition name
void	setDescription(java.lang.String description)

Methods inherited from class java.lang.Object

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

Field Detail

UPDATE

public static final java.lang.String UPDATE

See Also:

Constant Field Values

PREVIEW

public static final java.lang.String PREVIEW

See Also:

Constant Field Values

RESET

public static final java.lang.String RESET

See Also:

Constant Field Values

DOC_INFO

public static final java.lang.String DOC_INFO

See Also:

Constant Field Values

DOC_INFO_UPDATE

public static final java.lang.String DOC_INFO_UPDATE

See Also:

Constant Field Values

SWITCH_DATA_FILE

public static final java.lang.String SWITCH_DATA_FILE

See Also:

Constant Field Values

SWITCH_REGION_TEMPLATE

public static final java.lang.String SWITCH_REGION_TEMPLATE

See Also:

Constant Field Values

MODIFY_METADATA

public static final java.lang.String MODIFY_METADATA

See Also:

Constant Field Values

APPROVE

public static final java.lang.String APPROVE

See Also:

Constant Field Values

REJECT

public static final java.lang.String REJECT

See Also:

Constant Field Values

VIEW_USAGE_REPORT

public static final java.lang.String VIEW_USAGE_REPORT

See Also:

Constant Field Values

VIEW_TRACKER_REPORT

public static final java.lang.String VIEW_TRACKER_REPORT

See Also:

Constant Field Values

REMOVE_ASSOCIATION

public static final java.lang.String REMOVE_ASSOCIATION

See Also:

Constant Field Values

Constructor Detail

PlaceholderDefinition

public PlaceholderDefinition()

Create an empty placeholder definition

PlaceholderDefinition

public PlaceholderDefinition(oracle.stellent.wcm.core.definition.placeholder.model.PlaceholderDefinitionType model)

Create a placeholder definition with the supplied properties and region schema view mapping

Parameters:

model - the placeholder definition model

Method Detail

getModel

public oracle.stellent.wcm.core.definition.placeholder.model.PlaceholderDefinitionType getModel()

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

isEmpty

public boolean isEmpty()

Returns:

true if this placeholder definition has no region templates and no subtemplates

containsRegionDefinition

public boolean containsRegionDefinition(java.lang.String definitionName)

Determine if the given definitionName is mapped in this placeholder

Parameters:

definitionName - the definition name

Returns:

true if their is a mapping

containsSubtemplate

public boolean containsSubtemplate(java.lang.String templateName)

Determine if the given subtemplate is in this placeholder

Parameters:

templateName - the template name

Returns:

true if their is an entry for this template

getRegionTemplates

public java.util.List<java.lang.String> getRegionTemplates(java.lang.String definitionName)

Retrieve the region views for the given definition name

Parameters:

definitionName - the region definition name

Returns:

the region views for the schema

getRegionDefinitionNames

public java.util.Collection<java.lang.String> getRegionDefinitionNames()

Returns:

a listing of the region definition names that have mapped views

addRegionDefinition

public void addRegionDefinition(java.lang.String definitionName)

Add a region definition reference to this placeholder config

Parameters:

definitionName - the schema name

removeRegionDefinition

public void removeRegionDefinition(java.lang.String definitionName)

Remove the region definition and all associated templates

Parameters:

definitionName - the schema name

addRegionTemplate

public void addRegionTemplate(java.lang.String regionDefinition,
                              java.lang.String template)

Add a region definition to template mapping

Parameters:

regionDefinition - the region definition name

template - the view name

removeRegionTemplate

public void removeRegionTemplate(java.lang.String definitionName,
                                 java.lang.String templateName)

Remove the region template view

Parameters:

definitionName - the definition name

templateName - the template name to remove

containsRegionTemplate

public boolean containsRegionTemplate(java.lang.String definitionName,
                                      java.lang.String templateName)

Determine if the region template is mapped to this definition

Parameters:

definitionName - the definition

templateName - the template name

Returns:

true if their is a mapping between this template and definition

addRegionTemplate

public void addRegionTemplate(java.lang.String definitionName,
                              java.lang.String templateName,
                              boolean isDefault)

Add a region definition to template mapping

Parameters:

definitionName - the region schema name

templateName - the view name

isDefault - if true, set this as the default view for this schema

getDefaultRegionTemplate

public java.lang.String getDefaultRegionTemplate(java.lang.String definitionName)

Retrieve the default region template for the given definition

Parameters:

definitionName - the definition name

Returns:

the default template

setDefaultRegionTemplate

public void setDefaultRegionTemplate(java.lang.String regionDefinition,
                                     java.lang.String template)

Set a template to be the default for a given definition name

Parameters:

regionDefinition - the definition name

template - the region template

getSubtemplates

public java.util.List<java.lang.String> getSubtemplates()

Returns:

a list of the contentIDs (dDocName) of the available subtemplates for this placeholder

addSubtemplate

public void addSubtemplate(java.lang.String contentID)

Add the subtemplate to the list

Parameters:

contentID - the content ID of the subtemplate

removeSubtemplate

public void removeSubtemplate(java.lang.String contentID)

Remove a subtemplate from the list of available templates

Parameters:

contentID - the content ID (dDocName) of the subtemplate

merge

public void merge(PlaceholderDefinition placeholderDefinition)

Merge the given placeholder definition into this definition

Parameters:

placeholderDefinition - the placeholder definition

isActionSet

public boolean isActionSet(PlaceholderDefinition.Action action)

Determine if the given action is set

Parameters:

action - the action

Returns:

true if the action is set

getFlagMap

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

Retrieve the actions settings as a map of action to boolean

Returns:

a map of action name to flag value

setAction

public void setAction(PlaceholderDefinition.Action action,
                      boolean value)

Set the action to the given value

Parameters:

action - the action to set

value - the value

removeAction

public void removeAction(PlaceholderDefinition.Action action)

Remove an action from this definition

Parameters:

action - the action to remove

removeActions

public void removeActions()

Remove all the actions on this placeholder definition

getProperty

protected oracle.stellent.wcm.core.definition.placeholder.model.Property getProperty(java.lang.String name)

getFlagsProperty

protected oracle.stellent.wcm.core.definition.placeholder.model.ComplexProperty getFlagsProperty()

getRegionDefinitionType

protected oracle.stellent.wcm.core.definition.placeholder.model.RegionDefinitionType getRegionDefinitionType(java.lang.String definitionName)

getSubtemplateType

protected oracle.stellent.wcm.core.definition.placeholder.model.SubTemplateType getSubtemplateType(java.lang.String contentID)

Skip navigation links