com.endeca.content
Interface ContentItem

public interface ContentItem

A single content item from an instance of a ContentResult object.

Each content item contains a map of child Property objects, which are keyed by property name. Child properties are also accessible sequentially via a property iterator.

Child content items may be nested explicitly within child properties.

Since:

1.0.0

Version:

2.0.0

See Also:

ContentResults.getContent(), Property.getValue()

Method Summary

java.lang.String	getName() The name for this content item.
Property	getProperty(java.lang.String pKey) Returns the Property object associated with the specified key or null if there is no associated Property.
java.util.List	getPropertyList() Returns an immutable list of child Property objects.
java.util.Map	getPropertyMap() Returns an immutable map of child Property objects.
java.lang.String	getTemplateId() The id for the template used to create the content item.
java.lang.String	getTemplateType() The template type for the content item.
java.util.Iterator	iterator() Returns a sequential iterator of child Property objects.

Method Detail

getTemplateType

java.lang.String getTemplateType()

The template type for the content item.

Returns:

the template type for the content item.

getTemplateId

java.lang.String getTemplateId()

The id for the template used to create the content item.

Returns:

the template id.

getName

java.lang.String getName()

The name for this content item. The value for the name attribute is typically specified via a content management tool and may or may not have any semantic meaning for the application.

Returns:

the name of the content item.

getProperty

Property getProperty(java.lang.String pKey)

Returns the Property object associated with the specified key or null if there is no associated Property.

Parameters:

pKey - the property key

Returns:

the Property object associated with the specified key or null.

iterator

java.util.Iterator iterator()

Returns a sequential iterator of child Property objects.

Returns:

a sequential iterator of child Property objects.

getPropertyMap

java.util.Map getPropertyMap()

Returns an immutable map of child Property objects.

Returns:

an immutable map of child Property objects.

getPropertyList

java.util.List getPropertyList()

Returns an immutable list of child Property objects.

Returns:

an immutable list of child Property objects.