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

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

All Known Subinterfaces:

IMutableIdMapperManager

public interface IIdMapperManager

Read-Only 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 look up resources based on ids.

Method Summary

java.lang.String	getUniqueId(IResourceHandle resourceHandle) Get unique id of resource.
java.util.Map	getUniqueIds(java.util.List resourceHandles) Get list of unique ids by list of resources.
java.util.Map	lookup(java.util.List uniqueIds) Look up resources in repository by list of unique ids.
IResourceHandle	lookup(java.lang.String uniqueId) Look up resource in repository by unique id.

Method Detail

lookup

public IResourceHandle lookup(java.lang.String uniqueId)
                       throws ResourceException

Look up resource in repository by unique id.

Parameters:

uniqueId - unique id

Returns:

looked up resource

Throws:

ResourceException - when a general problem occures

getUniqueId

public java.lang.String getUniqueId(IResourceHandle resourceHandle)
                             throws ResourceException

Get unique id of resource.

Parameters:

resourceHandle - resource handle

Returns:

unique id of resource handle

Throws:

ResourceException - when a general problem occures

lookup

public java.util.Map lookup(java.util.List uniqueIds)
                     throws ResourceException,
                            OperationNotCompletedException

Look up resources in repository by list of unique 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:

uniqueIds - list of unique ids

Returns:

map of looked up resources indexed by unique id

Throws:

ResourceException - when a general problem occures

OperationNotCompletedException - when the operation failed in parts

getUniqueIds

public java.util.Map getUniqueIds(java.util.List resourceHandles)
                           throws ResourceException,
                                  OperationNotCompletedException

Get list of unique ids by list of resources.

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:

resourceHandles - list of resource handles

Returns:

map of looked up unique ids of resource handles indexed by resource handles

Throws:

ResourceException - when a general problem occures

OperationNotCompletedException - when the operation failed in parts