Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.service.urimapper
Interface IUriMapperService

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.global.service.urimapper_api.jar]
All Superinterfaces:
IService
public interface IUriMapperService
extends IService

Maps arbitrary length resource IDs (URIs and RIDs) to fixed length shorter ID strings and vice versa.

Field Summary
static java.lang.String SERVICE_ID
          The identifier of this service.
 
Method Summary
 java.lang.String getConstantID(RID rid)
          Maps a given RID onto a constant unique ID.
 java.lang.String getConstantID(URI uri)
          Deprecated. as of NW04.
 java.lang.String[] getConstantIDs(IRidList ridList)
          Maps a list of RIDs to a list of constant unique IDs.
 java.lang.String getCreateConstantID(RID rid)
          Maps a given URI onto a constant unique ID.
 java.lang.String getCreateConstantID(URI uri)
          Deprecated. as of NW04.
 java.lang.String getCreateVariableID(RID rid)
          Maps a given RID onto a variable unique ID.
 java.lang.String getCreateVariableID(URI uri)
          Deprecated. as of NW04.
 RID getRIDFromConstantID(java.lang.String constantID)
          Maps a given constant ID onto the matching RID.
 RID getRIDFromVariableID(java.lang.String variableID)
          Maps a given variable ID onto the matching RID.
 URI getUriFromConstantID(java.lang.String constantID)
          Deprecated. as of NW04.
 URI getUriFromVariableID(java.lang.String variableID)
          Deprecated. as of NW04.
 java.lang.String getVariableID(RID rid)
          Maps a given RID onto a variable unique ID.
 java.lang.String getVariableID(URI uri)
          Deprecated. as of NW04.
 java.lang.String[] getVariableIDs(IRidList ridList)
          Maps a list of RIDs to a list of variable unique IDs.
 void removeMultipleIDs(RID id)
          Remove mapping for the given RID and all descendants, e.g. id/*.
 void removeMultipleIDs(URI id)
          Deprecated. as of NW04.
 boolean removeSingleID(RID id)
          Remove mapping for the given RID.
 boolean removeSingleID(URI id)
          Deprecated. as of NW04.
 void renameMultipleIDs(RID fromId, RID toId)
          Rename mapping for the given RID and all descendants, e.g. id/*.
 void renameMultipleIDs(URI fromId, URI toId)
          Deprecated. as of NW04.
 boolean renameSingleID(RID fromId, RID toId)
          Rename mapping for the given RID.
 boolean renameSingleID(URI fromId, URI toId)
          Deprecated. as of NW04.
 
Methods inherited from interface com.sapportals.wcm.service.IService
getDescription, getDescription, getID
 

Field Detail

SERVICE_ID

public static final java.lang.String SERVICE_ID
The identifier of this service. To be used as a parameter for the getService() method at the service factory to access this service.
Method Detail

getConstantID

public java.lang.String getConstantID(RID rid)
                               throws WcmException
Maps a given RID onto a constant unique ID. If no mapping exists then null is returned.
Parameters:
rid - to map
Returns:
ID string for RID
Throws:
WcmException - Exception raised in failure situation

getConstantID

public java.lang.String getConstantID(URI uri)
                               throws WcmException
Deprecated. as of NW04.

Maps a given URI onto a constant unique ID. If no mapping exists then null is returned.
Parameters:
uri - to map
Returns:
ID string for uri
Throws:
WcmException - Exception raised in failure situation

getConstantIDs

public java.lang.String[] getConstantIDs(IRidList ridList)
                                  throws WcmException
Maps a list of RIDs to a list of constant unique IDs. The order is preserved, that means the unique ID will have the same index in the resulting array as the RID it belongs to in the RID list. If a constant unique ID does not exist for a RID the array will contain a null entry.
Parameters:
ridList - List of RIDs
Returns:
Array of unique IDs.

getCreateConstantID

public java.lang.String getCreateConstantID(RID rid)
                                     throws WcmException
Maps a given URI onto a constant unique ID. If no mapping exists for the URI then a new one is created.
Parameters:
rid - to map
Returns:
ID string for uri
Throws:
WcmException - Exception raised in failure situation

getCreateConstantID

public java.lang.String getCreateConstantID(URI uri)
                                     throws WcmException
Deprecated. as of NW04.

Maps a given URI onto a variable unique ID. If no mapping exists for the URI then a new one is created.
Parameters:
uri - to map
Returns:
ID string for uri
Throws:
WcmException - Exception raised in failure situation

getUriFromConstantID

public URI getUriFromConstantID(java.lang.String constantID)
                         throws WcmException
Deprecated. as of NW04.

Maps a given constant ID onto the matching URI.
Parameters:
constantID - TBD: Description of the incoming method parameter
Returns:
URI matching given ID
Throws:
WcmException - Exception raised in failure situation

getRIDFromConstantID

public RID getRIDFromConstantID(java.lang.String constantID)
                         throws WcmException
Maps a given constant ID onto the matching RID.
Parameters:
constantID - TBD: Description of the incoming method parameter
Returns:
RID matching given ID
Throws:
WcmException - Exception raised in failure situation

getVariableID

public java.lang.String getVariableID(URI uri)
                               throws WcmException
Deprecated. as of NW04.

Maps a given URI onto a variable unique ID. If no mapping exists then null is returned.
Parameters:
uri - to map
Returns:
ID string for uri
Throws:
WcmException - Exception raised in failure situation

getVariableID

public java.lang.String getVariableID(RID rid)
                               throws WcmException
Maps a given RID onto a variable unique ID. If no mapping exists then null is returned.
Parameters:
rid - to map
Returns:
ID string for rid
Throws:
WcmException - Exception raised in failure situation

getCreateVariableID

public java.lang.String getCreateVariableID(URI uri)
                                     throws WcmException
Deprecated. as of NW04.

Maps a given URI onto a variable unique ID. If no mapping exists for the URI then a new one is created.
Parameters:
uri - to map
Returns:
ID string for uri
Throws:
WcmException - Exception raised in failure situation

getCreateVariableID

public java.lang.String getCreateVariableID(RID rid)
                                     throws WcmException
Maps a given RID onto a variable unique ID. If no mapping exists for the RID then a new one is created.
Parameters:
rid - to map
Returns:
ID string for rid
Throws:
WcmException - Exception raised in failure situation

getUriFromVariableID

public URI getUriFromVariableID(java.lang.String variableID)
                         throws WcmException
Deprecated. as of NW04.

Maps a given variable ID onto the matching URI.
Parameters:
variableID -  
Returns:
URI matching given ID
Throws:
WcmException - Exception raised in failure situation

getRIDFromVariableID

public RID getRIDFromVariableID(java.lang.String variableID)
                         throws WcmException
Maps a given variable ID onto the matching RID.
Parameters:
variableID -  
Returns:
RID matching given ID
Throws:
WcmException - Exception raised in failure situation

getVariableIDs

public java.lang.String[] getVariableIDs(IRidList ridList)
                                  throws WcmException
Maps a list of RIDs to a list of variable unique IDs. The order is preserved, that means the unique ID will have the same index in the resulting array as the RID it belongs to in the RID list. If a variable unique ID does not exist for a RID the array will contain a null entry.
Parameters:
ridList - List of RIDs
Returns:
Array of unique IDs.

removeMultipleIDs

public void removeMultipleIDs(URI id)
                       throws WcmException
Deprecated. as of NW04.

Remove mapping for the given URI and all descendants, e.g. id/*.
Parameters:
id: - exact URI and descendants to remove
Throws:
WcmException - Exception raised in failure situation

removeMultipleIDs

public void removeMultipleIDs(RID id)
                       throws WcmException
Remove mapping for the given RID and all descendants, e.g. id/*.
Parameters:
id: - exact RID and descendants to remove
Throws:
WcmException - Exception raised in failure situation

removeSingleID

public boolean removeSingleID(URI id)
                       throws WcmException
Deprecated. as of NW04.

Remove mapping for the given URI.
Parameters:
id: - exact URI to remove mapping for.
Returns:
true if a mapping was removed.
Throws:
WcmException - Exception raised in failure situation

removeSingleID

public boolean removeSingleID(RID id)
                       throws WcmException
Remove mapping for the given RID.
Parameters:
id: - exact RID to remove mapping for.
Returns:
true if a mapping was removed.
Throws:
WcmException - Exception raised in failure situation

renameMultipleIDs

public void renameMultipleIDs(URI fromId,
                              URI toId)
                       throws WcmException
Deprecated. as of NW04.

Rename mapping for the given URI and all descendants, e.g. id/*.
Parameters:
fromId: - exact URI and descendants to rename.
toId: - new URI to rename to.
Throws:
WcmException - Exception raised in failure situation

renameMultipleIDs

public void renameMultipleIDs(RID fromId,
                              RID toId)
                       throws WcmException
Rename mapping for the given RID and all descendants, e.g. id/*.
Parameters:
fromId: - exact RID and descendants to rename.
toId: - new RID to rename to.
Throws:
WcmException - Exception raised in failure situation

renameSingleID

public boolean renameSingleID(URI fromId,
                              URI toId)
                       throws WcmException
Deprecated. as of NW04.

Rename mapping for the given URI.
Parameters:
fromId: - exact URI to rename.
toId: - new URI to rename to.
Returns:
true if a mapping was renamed.
Throws:
WcmException - Exception raised in failure situation

renameSingleID

public boolean renameSingleID(RID fromId,
                              RID toId)
                       throws WcmException
Rename mapping for the given RID.
Parameters:
fromId: - exact RID to rename.
toId: - new RID to rename to.
Returns:
true if a mapping was renamed.
Throws:
WcmException - Exception raised in failure situation
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
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.