Package com.adobe.cq.wcm.core.components.models

Interface ListItem

All Superinterfaces:

Component, ComponentExporter

All Known Subinterfaces:

LanguageNavigationItem, NavigationItem

@ConsumerType
public interface ListItem
extends Component

Interface for a generic list item, used by the List and Search models.

Since:

com.adobe.cq.wcm.core.components.models 12.2.0

Field Summary

Fields inherited from interface com.adobe.cq.wcm.core.components.models.Component

PN_ID

Method Summary

Modifier and Type	Method	Description
default @Nullable java.lang.String	getDescription()	Returns the description of this ListItem.
default @Nullable java.util.Calendar	getLastModified()	Returns the date when this ListItem was last modified.
default @Nullable Link	getLink()	Returns the link of this ListItem.
default @Nullable java.lang.String	getName()	Returns the name of this ListItem.
default @Nullable java.lang.String	getPath()	Returns the path of this ListItem.
default @Nullable Resource	getTeaserResource()	Returns a wrapped resource of the item which is used to render the item as a Teaser component.
default @Nullable java.lang.String	getTitle()	Returns the title of this ListItem.
default @Nullable java.lang.String	getURL()	Deprecated. Please use getLink()

Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component

getAppliedCssClasses, getData, getExportedType, getId

Method Detail

getLink

@Nullable
default @Nullable Link getLink()

Returns the link of this ListItem.

Returns:

the link of this list item.

Since:

com.adobe.cq.wcm.core.components.models 12.20.0

getURL

@Deprecated
@Nullable
default @Nullable java.lang.String getURL()

Deprecated.

Please use getLink()

Returns the URL of this ListItem.

Returns:

the URL of this list item or null

Since:

com.adobe.cq.wcm.core.components.models 12.2.0

getTitle

@Nullable
default @Nullable java.lang.String getTitle()

Returns the title of this ListItem.

Returns:

the title of this list item or null

Since:

com.adobe.cq.wcm.core.components.models 12.2.0

getDescription

@Nullable
default @Nullable java.lang.String getDescription()

Returns the description of this ListItem.

Returns:

the description of this list item or null

Since:

com.adobe.cq.wcm.core.components.models 12.2.0

getLastModified

@Nullable
default @Nullable java.util.Calendar getLastModified()

Returns the date when this ListItem was last modified.

Returns:

the last modified date of this list item or null

Since:

com.adobe.cq.wcm.core.components.models 12.2.0

getPath

@Nullable
default @Nullable java.lang.String getPath()

Returns the path of this ListItem.

Returns:

the list item path or null

Since:

com.adobe.cq.wcm.core.components.models 12.2.0

getName

@Nullable
default @Nullable java.lang.String getName()

Returns the name of this ListItem.

Returns:

the list item name or null

Since:

com.adobe.cq.wcm.core.components.models 12.6.0

getTeaserResource

@Nullable
default @Nullable Resource getTeaserResource()

Returns a wrapped resource of the item which is used to render the item as a Teaser component. The wrapped resource is either: - the featured image of the item page, if it exists - the content node of the item page, if it exists - null otherwise

Returns:

wrapped resource of the item which can be rendered as a Teaser component

Since:

com.adobe.cq.wcm.core.components.models 12.21.0