com.endeca.infront.cartridge

Class ContentSlotConfig

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.endeca.infront.assembler.BasicContentItem

com.endeca.infront.cartridge.ContentSlotConfig

All Implemented Interfaces:

ContentItem, Serializable, Cloneable, Map<String,Object>

public class ContentSlotConfig
extends BasicContentItem

ContentSlotHandler configuration model.

The ContentSlotConfig is a ContentItem that describes where Experience Manager content should be retrieved from, which types of content to retrieve, and how many items are required.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ContentSlotConfig() Constructor that sets the type to "ContentSlot".
ContentSlotConfig(ContentItem pContentItem) Creates a ContentSlotConfig and copies the configuration present in the input ContentItem.
ContentSlotConfig(String pType) Creates a ContentSlotConfig.
ContentSlotConfig(String pContentCollection, int pRuleLimit) Deprecated. Use ContentSlotConfig()
ContentSlotConfig(String pType, String pContentCollection, int pRuleLimit) Deprecated. Use ContentSlotConfig(String)

Method Summary

Methods

Modifier and Type	Method and Description
String	getContentCollection() Deprecated. Use getContentPaths() instead
List<String>	getContentPaths() Returns the paths which will be searched for content items to be considered for inclusion in this slot.
int	getRuleLimit() Returns the maximum number of rules that can fire for this slot.
List<String>	getTemplateIds() Returns the template IDs from which content items must have been created in order to be considered for inclusion in this slot.
List<String>	getTemplateTypes() Returns the template types from which content items must have been created in order to be considered for inclusion in this slot.
void	setContentCollection(String contentCollection) Deprecated. Use setContentPaths(java.util.List) instead
void	setContentPaths(List<String> contentPaths) Sets which paths will be searched for content items to be considered for inclusion in this slot.
void	setRuleLimit(int ruleLimit) Sets the maximum number of rules that can fire for this slot.
void	setTemplateIds(List<String> templateIds) Sets the template IDs from which content items must have been created in order to be considered for inclusion in this slot.
void	setTemplateTypes(List<String> templateTypes) Sets the template types from which content items must have been created in order to be considered for inclusion in this slot.

Methods inherited from class com.endeca.infront.assembler.BasicContentItem

getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty, setType

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

ContentSlotConfig

@Deprecated
public ContentSlotConfig(String pContentCollection,
                            int pRuleLimit)

Deprecated. Use ContentSlotConfig()

Creates a ContentSlotConfig with type "ContentSlot" and specified content collection and rule limit.

Parameters:

pContentCollection - the content collection

pRuleLimit - the maximum number of rules that can fire for this slot

ContentSlotConfig

@Deprecated
public ContentSlotConfig(String pType,
                            String pContentCollection,
                            int pRuleLimit)

Deprecated. Use ContentSlotConfig(String)

Creates a ContentSlotConfig.

Parameters:

pType - the type for this config object

pContentCollection - the content collection

pRuleLimit - the maximum number of rules that can fire for this slot

ContentSlotConfig

public ContentSlotConfig(ContentItem pContentItem)

Creates a ContentSlotConfig and copies the configuration present in the input ContentItem.

Parameters:

pContentItem - the contents for this instance

ContentSlotConfig

public ContentSlotConfig()

Constructor that sets the type to "ContentSlot".

ContentSlotConfig

public ContentSlotConfig(String pType)

Creates a ContentSlotConfig.

Parameters:

pType - the type for this config object

Method Detail

getContentCollection

@Deprecated
public String getContentCollection()

Deprecated. Use getContentPaths() instead

Returns the content collection name.

setContentCollection

@Deprecated
public void setContentCollection(String contentCollection)

Deprecated. Use setContentPaths(java.util.List) instead

Sets the content collection name.

getContentPaths

public List<String> getContentPaths()

Returns the paths which will be searched for content items to be considered for inclusion in this slot.

setContentPaths

public void setContentPaths(List<String> contentPaths)

Sets which paths will be searched for content items to be considered for inclusion in this slot.

getTemplateTypes

public List<String> getTemplateTypes()

Returns the template types from which content items must have been created in order to be considered for inclusion in this slot.

setTemplateTypes

public void setTemplateTypes(List<String> templateTypes)

Sets the template types from which content items must have been created in order to be considered for inclusion in this slot.

getTemplateIds

public List<String> getTemplateIds()

Returns the template IDs from which content items must have been created in order to be considered for inclusion in this slot.

setTemplateIds

public void setTemplateIds(List<String> templateIds)

Sets the template IDs from which content items must have been created in order to be considered for inclusion in this slot.

getRuleLimit

public int getRuleLimit()

Returns the maximum number of rules that can fire for this slot. The default value is 1.

setRuleLimit

public void setRuleLimit(int ruleLimit)

Sets the maximum number of rules that can fire for this slot.