com.sap.netweaver.bc.rf.mi.idmapper
Interface IMutableIdMapperManager

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.mi_api.jar]

All Superinterfaces:

IIdMapperManager

public interface IMutableIdMapperManager

extends IIdMapperManager

Read-And-Write interface describing a repository sub manager for id mapping. Ids must identify a resource uniquely in the repository, no matter how its position or properties change. When its identity really gets lost or is replaced, the id must never be used again resp. a new id must be assigned to the new resource replacing the old (possibly on the same position). Ids must never be reused in order to undoubtedly identify a resource resp. that the resource no longer exists (e.g. when ids sent through emails are used to identify the referenced resource again). This interface allows to assign unique ids to resources in a repository from outside. They should be globally unique ids in order to fulfill the requirements (uniqueness, no reuse) in a performant way (no check expected here where all resources are checkd for the new id in the repository).

Method Summary

void	assignToResource(IResourceHandle resourceHandle, java.lang.String uniqueId) Assign unique id to resource handle.
void	assignToResources(java.util.Map uniqueIdsIndexedByResourceHandles) Assign list of unique ids to list of resource handles.
void	assignToRid(IRid resourceId, java.lang.String uniqueId) Assign unique id to resource id.
void	assignToRids(java.util.Map uniqueIdsIndexedByResourceIds) Assign list of unique ids to list of resource ids.

Methods inherited from interface com.sap.netweaver.bc.rf.mi.idmapper.IIdMapperManager

getUniqueId, getUniqueIds, lookup, lookup

Method Detail

assignToRid

public void assignToRid(IRid resourceId,
                        java.lang.String uniqueId)
                 throws ResourceException

Assign unique id to resource id.

Parameters:

resourceId - resource id

uniqueId - unique id to be assigned

Throws:

ResourceException - when a general problem occures, the resource id is invalid or the unique id is already in use

assignToResource

public void assignToResource(IResourceHandle resourceHandle,
                             java.lang.String uniqueId)
                      throws ResourceException

Assign unique id to resource handle.

Parameters:

resourceHandle - resource handle

uniqueId - unique id to be assigned

Throws:

ResourceException - when a general problem occures, the resource handle is invalid or the unique id is already in use

assignToRids

public void assignToRids(java.util.Map uniqueIdsIndexedByResourceIds)
                  throws ResourceException,
                         OperationNotCompletedException

Assign list of unique ids to list of resource ids.

Note: This method needs not to be handled atomically! Although this operation may fail in parts, the operation on one of the many operands provided through the parameter list is always expected to be atomic!

Parameters:

uniqueIdsIndexedByResourceIds - map of unique ids to be assigned indexed by resource ids

Throws:

ResourceException - when a general problem occures

OperationNotCompletedException - when the operation failed in parts

assignToResources

public void assignToResources(java.util.Map uniqueIdsIndexedByResourceHandles)
                       throws ResourceException,
                              OperationNotCompletedException

Assign list of unique ids to list of resource handles.

Note: This method needs not to be handled atomically! Although this operation may fail in parts, the operation on one of the many operands provided through the parameter list is always expected to be atomic!

Parameters:

uniqueIdsIndexedByResourceHandles - map of unique ids to be assigned indexed by resource handles

Throws:

ResourceException - when a general problem occures

OperationNotCompletedException - when the operation failed in parts