com.sapportals.wcm.service.urimapper

Interface IUriMapperService

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 String

SERVICE_ID The identifier of this service.

Method Summary

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 URI onto a constant unique ID.
String	getCreateConstantID(URI uri) Deprecated. as of NW04.
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

public 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

public 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 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 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

public 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 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(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(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

public 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

public 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

public 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 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 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 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(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(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 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

public void removeMultipleIDs(URI id)
                       throws WcmException

Deprecated. as of NW04.

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

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/*.

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.

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.

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/*.

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/*.

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.

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.

Returns:

true if a mapping was renamed.

Throws:

WcmException - Exception raised in failure situation