SAP NetWeaver '04

com.sapportals.wcm.rendering.base
Interface IRIDMapper

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.base_api.jar]
public interface IRIDMapper

Since:
NW04, SPS5 a service interface that can be implemented by an IProxy. During the rendering process, classes request mappers for the RID instances they need to persist on the html-page. So instead that many classes write the complete RID on the page, they all just write the (shorter) mapping on the page.
When the user clicked something on the html-page, the receiving class will call the getRID(Sting mapper) method to retrieve the actual RID. So the implementing class has to ensure that the mapping will survive the server-roundtrip.

Method Summary
 java.lang.String getMapper(RID rid)
          to be used during the rendering process.
 RID getRID(java.lang.String mapper)
          to be used when an event has been received.
 

Method Detail

getMapper

public java.lang.String getMapper(RID rid)
to be used during the rendering process.
Parameters:
rid - the rid of the resource that a mapping is needed for. Must not be null. The RID should not have to be encoded.
Returns:
a (shorter) representation of the given RID. If several requests for the same RID have been received, they should all return the same result.

getRID

public RID getRID(java.lang.String mapper)
to be used when an event has been received.
Parameters:
mapper - the mapper that has been created using the getMapper method. Must not be null
Returns:
the RID as it has been provided in the getMapper method:
ridProvided.equals(ridReturned) == true
If no RID exists for this mapper, a NullPointerException will be thrown.

SAP NetWeaver '04

Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.