com.sapportals.wcm.service.reporting

Interface ILinkResultItem

All Superinterfaces:

IResultItem

All Known Implementing Classes:

ResultItem

public interface ILinkResultItem
extends IResultItem

Represents a reported item in a IReportResult enhanced with link information.

A ILinkResultItem gives extra information for result renderer such as a graphical user interface. The purpose is to link thus result item to further information. The link is intended to replace the default rendering of item RIDs.

All of the information can be null which is the default if a report does not care or know about this interface.

Copyright (c) SAP AG 2004

Method Summary

com.sapportals.wcm.util.uri.IUriReference	getLinkReference() Get reference (where the link points to) or null if not defined.
String	getLinkTarget() Get target of link reference (as in HTML anchor) or null if not defined
String	getLinkText() Get text displayed as link
boolean	isDead() The item, designated by its RID, is known to be dead, e.g.

Methods inherited from interface com.sapportals.wcm.service.reporting.IResultItem

getExecutedCommands, getProperties, getRID, getStatusDescription, hadError

Method Detail

isDead

boolean isDead()

The item, designated by its RID, is known to be dead, e.g. it no longer exists.

Returns:

getLinkText

String getLinkText()

Get text displayed as link

Returns:

text displayed as link or null if not defined

getLinkTarget

String getLinkTarget()

Get target of link reference (as in HTML anchor) or null if not defined

Returns:

target of link reference

getLinkReference

com.sapportals.wcm.util.uri.IUriReference getLinkReference()

Get reference (where the link points to) or null if not defined.

Returns:

reference where link points to

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM