com.sap.portal.pcm.relateditem

Interface IRelatedItemEntity


public interface IRelatedItemEntity

The interface that represents a related item associated with an iView.

See Also:
ILayout, IPages, IAttrPage

Method Summary
 String getDescription(Locale locale)
          Gets the description of the related item for the specified locale.
 String getFullPath()
          Gets the PCD path for the related item object.
 PcmUri getIcon(ObjectState state)
          Gets the the URL and URL type for the icon.
 List getParentsIds()
          Gets the IDs of the parents for this related item.
 String getTarget()
          Gets the related item target name.
 String getTitle(Locale locale)
          Gets the title of the related item for the specified locale.
 RelatedItemType getType()
          Gets the type of the related item.
 boolean isActive()
          Indicates whether the related item is active (visible) or inactive (hidden).
 boolean isBrokenDL()
          Indicates whether the related item is a broken delta link
 boolean isDirect()
          Indicates whether the related item is a direct or indirect related item.
 

Method Detail

getTarget

String getTarget()
Gets the related item target name.

Returns:
the PCD address of the target

getType

RelatedItemType getType()
Gets the type of the related item.

Returns:
type of the related item

isActive

boolean isActive()
Indicates whether the related item is active (visible) or inactive (hidden).

Returns:
true (active), false

isDirect

boolean isDirect()
Indicates whether the related item is a direct or indirect related item.

Returns:
true (direct) or false (indirect)

getParentsIds

List getParentsIds()
Gets the IDs of the parents for this related item.

Returns:
a list of PCD addresses

getTitle

String getTitle(Locale locale)
Gets the title of the related item for the specified locale.

Parameters:
locale - the requested locale
Returns:
the title of the related item

getDescription

String getDescription(Locale locale)
Gets the description of the related item for the specified locale.

Parameters:
locale - the requested locale
Returns:
the description of the related item

getIcon

PcmUri getIcon(ObjectState state)
Gets the the URL and URL type for the icon. The icon is displayed in the related item editor.

Parameters:
state - the state of the icon
Returns:
the URL and URL type for the icon

getFullPath

String getFullPath()
Gets the PCD path for the related item object.

Returns:
the PCD path of this related item

isBrokenDL

boolean isBrokenDL()
Indicates whether the related item is a broken delta link

Returns:
true (broken delta link) or false
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] KMC-WPC [sap.com] tc/kmc/wpc/wpcfacade api EP-PIN-WPC-WCM
[sap.com] EP-RUNTIME [sap.com] tc/ep/semantics/api api EP-PIN


Copyright 2011 SAP AG Complete Copyright Notice