com.sapportals.wcm.service.urimapper

Interface IUriMapperService2

All Superinterfaces:

IService, IUriMapperService

public interface IUriMapperService2
extends IUriMapperService

Extends IUriMapper with a set of methods that pass in the ResourceContext XXX: internal use only

Field Summary

Fields inherited from interface com.sapportals.wcm.service.urimapper.IUriMapperService

SERVICE_ID

Method Summary

String	getConstantID(com.sapportals.wcm.util.uri.RID rid, IResourceContext context) Maps a given RID onto a constant unique ID.
String[]	getConstantIDs(com.sapportals.wcm.util.uri.IRidList ridList, IResourceContext context) Maps a list of RIDs to a list of constant unique IDs.
String	getCreateConstantID(com.sapportals.wcm.util.uri.RID rid, IResourceContext context) Maps a given RID onto a constant unique ID.
String[]	getCreateConstantIDs(com.sapportals.wcm.util.uri.IRidList rids, IResourceContext context) Maps a given set of RIDs onto a set of constant unique IDs.
String	getCreateVariableID(com.sapportals.wcm.util.uri.RID rid, IResourceContext context) Maps a given RID onto a variable unique ID.
com.sapportals.wcm.util.uri.RID	getGuidRIDFromRID(com.sapportals.wcm.util.uri.RID rid, IResourceContext context) Maps a given GUID RID onto the matching RID.
com.sapportals.wcm.util.uri.RID	getRIDFromConstantID(String constantID, IResourceContext context) Maps a given constant ID onto the matching RID.
com.sapportals.wcm.util.uri.RID	getRIDFromGuidRID(com.sapportals.wcm.util.uri.RID rid, IResourceContext context) Maps a given GUID RID onto the matching RID.
com.sapportals.wcm.util.uri.RID	getRIDFromVariableID(String variableID, IResourceContext context) Maps a given variable ID onto the matching RID.
String	getVariableID(com.sapportals.wcm.util.uri.RID rid, IResourceContext context) Maps a given RID onto a variable unique ID.
String[]	getVariableIDs(com.sapportals.wcm.util.uri.IRidList ridList, IResourceContext context) Maps a list of RIDs to a list of variable unique IDs.
void	removeMultipleIDs(com.sapportals.wcm.util.uri.RID id, IResourceContext context) Remove mapping for the given RID and all descendants, e.g. id/*.
boolean	removeSingleID(com.sapportals.wcm.util.uri.RID id, IResourceContext context) Remove mapping for the given RID.
void	renameMultipleIDs(com.sapportals.wcm.util.uri.RID fromId, com.sapportals.wcm.util.uri.RID toId, IResourceContext context) Rename mapping for the given RID and all descendants, e.g. id/*.
boolean	renameSingleID(com.sapportals.wcm.util.uri.RID fromId, com.sapportals.wcm.util.uri.RID toId, IResourceContext context) Rename mapping for the given RID.

Methods inherited from interface com.sapportals.wcm.service.urimapper.IUriMapperService

forceSingleIDMapping, forceSingleIDMapping, getConstantID, getConstantID, getConstantIDs, getCreateConstantID, getCreateConstantID, getCreateConstantIDs, getCreateVariableID, getCreateVariableID, getGuidRIDFromRID, getRIDFromConstantID, getRIDFromGuidRID, getRIDFromVariableID, getUriFromConstantID, getUriFromVariableID, getVariableID, getVariableID, getVariableIDs, removeMultipleIDs, removeMultipleIDs, removeSingleID, removeSingleID, renameMultipleIDs, renameMultipleIDs, renameSingleID, renameSingleID

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Method Detail

getConstantID

String getConstantID(com.sapportals.wcm.util.uri.RID rid,
                     IResourceContext context)
                     throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getConstantIDs

String[] getConstantIDs(com.sapportals.wcm.util.uri.IRidList ridList,
                        IResourceContext context)
                        throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException

getCreateConstantID

String getCreateConstantID(com.sapportals.wcm.util.uri.RID rid,
                           IResourceContext context)
                           throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getCreateConstantIDs

String[] getCreateConstantIDs(com.sapportals.wcm.util.uri.IRidList rids,
                              IResourceContext context)
                              throws com.sapportals.wcm.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:

ridList - List of RIDs

Returns:

Array of unique IDs.

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getRIDFromConstantID

com.sapportals.wcm.util.uri.RID getRIDFromConstantID(String constantID,
                                                     IResourceContext context)
                                                     throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getGuidRIDFromRID

com.sapportals.wcm.util.uri.RID getGuidRIDFromRID(com.sapportals.wcm.util.uri.RID rid,
                                                  IResourceContext context)
                                                  throws com.sapportals.wcm.WcmException

Maps a given GUID RID onto the matching RID.

Parameters:

rid - rid

Returns:

guid rid

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getRIDFromGuidRID

com.sapportals.wcm.util.uri.RID getRIDFromGuidRID(com.sapportals.wcm.util.uri.RID rid,
                                                  IResourceContext context)
                                                  throws com.sapportals.wcm.WcmException

Maps a given GUID RID onto the matching RID.

Parameters:

rid - guid rid

Returns:

rid

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getVariableID

String getVariableID(com.sapportals.wcm.util.uri.RID rid,
                     IResourceContext context)
                     throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getCreateVariableID

String getCreateVariableID(com.sapportals.wcm.util.uri.RID rid,
                           IResourceContext context)
                           throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getRIDFromVariableID

com.sapportals.wcm.util.uri.RID getRIDFromVariableID(String variableID,
                                                     IResourceContext context)
                                                     throws com.sapportals.wcm.WcmException

Maps a given variable ID onto the matching RID.

Parameters:

variableID -

Returns:

RID matching given ID

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getVariableIDs

String[] getVariableIDs(com.sapportals.wcm.util.uri.IRidList ridList,
                        IResourceContext context)
                        throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException

removeMultipleIDs

void removeMultipleIDs(com.sapportals.wcm.util.uri.RID id,
                       IResourceContext context)
                       throws com.sapportals.wcm.WcmException

Remove mapping for the given RID and all descendants, e.g. id/*.

Parameters:

id: - exact RID and descendants to remove

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

removeSingleID

boolean removeSingleID(com.sapportals.wcm.util.uri.RID id,
                       IResourceContext context)
                       throws com.sapportals.wcm.WcmException

Remove mapping for the given RID.

Parameters:

id: - exact RID to remove mapping for.

Returns:

true if a mapping was removed.

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

renameMultipleIDs

void renameMultipleIDs(com.sapportals.wcm.util.uri.RID fromId,
                       com.sapportals.wcm.util.uri.RID toId,
                       IResourceContext context)
                       throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException - Exception raised in failure situation

renameSingleID

boolean renameSingleID(com.sapportals.wcm.util.uri.RID fromId,
                       com.sapportals.wcm.util.uri.RID toId,
                       IResourceContext context)
                       throws com.sapportals.wcm.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:

com.sapportals.wcm.WcmException - Exception raised in failure situation

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] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM