com.sapportals.wcm.service.urimapper

Interface IUriMapperService

All Superinterfaces:

IService

All Known Subinterfaces:

IUriMapperService2

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 String

SERVICE_ID The identifier of this service.

Method Summary

void	forceSingleIDMapping(RID rid, String constantId) ATTENTION: for SAP internal use of transport system only Forces mapping of a given RID onto a given constant unique ID.
void	forceSingleIDMapping(RID rid, String constantId, String variableId) ATTENTION: for SAP internal use of transport system only Forces mapping of a given RID onto a given constant unique ID and a given variable ID.
String	getConstantID(RID rid) Maps a given RID onto a constant unique ID.
String	getConstantID(URI uri) Deprecated. as of NW04.
String[]	getConstantIDs(IRidList ridList) Maps a list of RIDs to a list of constant unique IDs.
String	getCreateConstantID(RID rid) Maps a given RID onto a constant unique ID.
String	getCreateConstantID(URI uri) Deprecated. as of NW04.
String[]	getCreateConstantIDs(IRidList rids) Maps a given set of RIDs onto a set of constant unique IDs.
String	getCreateVariableID(RID rid) Maps a given RID onto a variable unique ID.
String	getCreateVariableID(URI uri) Deprecated. as of NW04.
RID	getGuidRIDFromRID(RID rid) Maps a given GUID RID onto the matching RID.
RID	getRIDFromConstantID(String constantID) Maps a given constant ID onto the matching RID.
RID	getRIDFromGuidRID(RID rid) Maps a given GUID RID onto the matching RID.
RID	getRIDFromVariableID(String variableID) Maps a given variable ID onto the matching RID.
URI	getUriFromConstantID(String constantID) Deprecated. as of NW04.
URI	getUriFromVariableID(String variableID) Deprecated. as of NW04.
String	getVariableID(RID rid) Maps a given RID onto a variable unique ID.
String	getVariableID(URI uri) Deprecated. as of NW04.
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

static final 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.

See Also:

Constant Field Values

Method Detail

getConstantID

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

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

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.

Throws:

WcmException

getCreateConstantID

String getCreateConstantID(RID rid)
                           throws WcmException

Maps a given RID onto a constant unique ID. If no mapping exists for the RID then a new one is created.

Parameters:

rid - to map

Returns:

ID string for uri

Throws:

WcmException - Exception raised in failure situation

getCreateConstantIDs

String[] getCreateConstantIDs(IRidList rids)
                              throws WcmException

Maps a given set of RIDs onto a set 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 no mapping exists for a RID a new one is created.

Parameters:

rids - List of RIDs

Returns:

Array of unique IDs.

Throws:

WcmException - Exception raised in failure situation

getCreateConstantID

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

URI getUriFromConstantID(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

RID getRIDFromConstantID(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

getGuidRIDFromRID

RID getGuidRIDFromRID(RID rid)
                      throws WcmException

Maps a given GUID RID onto the matching RID.

Parameters:

rid - rid

Returns:

guid rid

Throws:

WcmException - Exception raised in failure situation

getRIDFromGuidRID

RID getRIDFromGuidRID(RID rid)
                      throws WcmException

Maps a given GUID RID onto the matching RID.

Parameters:

rid - guid rid

Returns:

rid

Throws:

WcmException - Exception raised in failure situation

getVariableID

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

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

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

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

URI getUriFromVariableID(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

RID getRIDFromVariableID(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

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.

Throws:

WcmException

removeMultipleIDs

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

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

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

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

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

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

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

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

forceSingleIDMapping

void forceSingleIDMapping(RID rid,
                          String constantId)
                          throws WcmException

ATTENTION: for SAP internal use of transport system only Forces mapping of a given RID onto a given constant unique ID. If there already is a mapping for the RID or onto the given for the URI it is deleted.

Parameters:

rid - to map

constantId - id to map to

Throws:

WcmException - Exception raised in failure situation

forceSingleIDMapping

void forceSingleIDMapping(RID rid,
                          String constantId,
                          String variableId)
                          throws WcmException

ATTENTION: for SAP internal use of transport system only Forces mapping of a given RID onto a given constant unique ID and a given variable ID. If there already is a mapping for the RID or onto the given for the URI it is deleted.

Parameters:

rid - to map

constantId - id to map to

variableId - to map to

Throws:

WcmException - Exception raised in failure situation

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