com.sap.portal.pcm.relateditem
Interface IRelatedItemEntity

public interface IRelatedItemEntity

Method Summary

java.lang.String	getDescription(java.util.Locale locale)
com.sap.portal.pcm.admin.PcmUri	getIcon(com.sap.portal.pcm.admin.ObjectState state)
java.util.List	getParentsIds()
java.lang.String	getTarget()
java.lang.String	getTitle(java.util.Locale locale)
RelatedItemType	getType()
boolean	isActive()
boolean	isDirect()

Method Detail

getTarget

public java.lang.String getTarget()

Returns:

the target of the delta-link

getType

public RelatedItemType getType()

Returns:

type of the related item (RelatedLinks, TargetComponents, DynamicNavigation)

isActive

public boolean isActive()

Returns:

whether the related item is active relative to the parent object

isDirect

public boolean isDirect()

Returns:

whether the related item is a direct child of the context it resides in

getParentsIds

public java.util.List getParentsIds()

Returns:

parent ids

getTitle

public java.lang.String getTitle(java.util.Locale locale)

Parameters:

locale - the requested locale

Returns:

title

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Parameters:

locale - the requested locale

Returns:

description

getIcon

public com.sap.portal.pcm.admin.PcmUri getIcon(com.sap.portal.pcm.admin.ObjectState state)

Parameters:

state -

Returns:

icon PcmUri

See Also:

ICatalogNode.getIcon(com.sap.portal.pcm.admin.ObjectState)