com.endeca.infront.cartridge

Class ContentInclude

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.endeca.infront.assembler.BasicContentItem

com.endeca.infront.cartridge.ContentInclude

All Implemented Interfaces:

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

public class ContentInclude
extends BasicContentItem

Contains a set of parameters used to make a request for content from the assembler.

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
ContentInclude() This empty constructor is used if content path is expected in site state.
ContentInclude(ContentItem pContentItem) Constructor that requires a ContentItem to describe the requested content.
ContentInclude(String pContentUri) Constructor that requires a URI to get the desired content.

Method Summary

Modifier and Type	Method and Description
String	getContentUri() The URI to retrieve content from a configured ContentSource.
void	setContentUri(String uri) Sets the URI to retrieve content from a configured ContentSource.

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

getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty, setType

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, 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, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

ContentInclude

public ContentInclude()

This empty constructor is used if content path is expected in site state.

ContentInclude

public ContentInclude(String pContentUri)

Constructor that requires a URI to get the desired content.

Parameters:

pContentUri - The URI for the content. The string should be properly url-encoded.

ContentInclude

public ContentInclude(ContentItem pContentItem)

Constructor that requires a ContentItem to describe the requested content.

Parameters:

pContentItem - Defines the requested content.

Method Detail

getContentUri

public String getContentUri()

The URI to retrieve content from a configured ContentSource.

setContentUri

public void setContentUri(String uri)

Sets the URI to retrieve content from a configured ContentSource.