wt.inf.template
Interface WorklistDrivenCopier

All Known Implementing Classes:
AbstractWorklistDrivenCopier

public interface WorklistDrivenCopier



Supported API: false

Extendable: false


Method Summary
 void addValueToList(Object listKey, Object listElement)
          Adds a value to a cached list.
 void cacheValue(Object key, Object value)
          Provides a place to cache values during the copy process It is the responsibility of the handler author to insure they are unique.
 WTContainerRef copyObjects(WTContainerRef sourceContainer, WTContainerRef targetContainer, ContainerCopyWorklist worklist)
          

Supported API: false
 Object getCacheValue(Object key)
          

Supported API: false
 ObjectIdentifier getTargetOid(Object oidKey)
          

Supported API: false
 List getValueList(Object listKey)
          

Supported API: false
 void initializeScript(WTContainerRef sourceCont, String scriptId)
          

Supported API: false
 void putTargetOid(Object oidKey, ObjectIdentifier oid)
          

Supported API: false
 

Method Detail

copyObjects

public WTContainerRef copyObjects(WTContainerRef sourceContainer,
                                  WTContainerRef targetContainer,
                                  ContainerCopyWorklist worklist)
                           throws WTException


Supported API: false

Parameters:
sourceContainer -
targetContainer - This is an unpersisted target container
worklist -
Returns:
WTContainerRef
Throws:
WTException

cacheValue

public void cacheValue(Object key,
                       Object value)
                throws WTException
Provides a place to cache values during the copy process It is the responsibility of the handler author to insure they are unique.

Supported API: false

Parameters:
key -
value -
Throws:
WTException

getCacheValue

public Object getCacheValue(Object key)
                     throws WTException


Supported API: false

Parameters:
key -
Returns:
Object
Throws:
WTException

getTargetOid

public ObjectIdentifier getTargetOid(Object oidKey)
                              throws WTException


Supported API: false

Parameters:
oidKey -
Returns:
ObjectIdentifier
Throws:
WTException

putTargetOid

public void putTargetOid(Object oidKey,
                         ObjectIdentifier oid)
                  throws WTException


Supported API: false

Parameters:
oidKey -
oid -
Throws:
WTException

addValueToList

public void addValueToList(Object listKey,
                           Object listElement)
                    throws WTException
Adds a value to a cached list. This is a convenience mechansim for managing lists which need to be remembered between handlers.

Supported API: false

Parameters:
listKey -
listElement -
Throws:
WTException

getValueList

public List getValueList(Object listKey)
                  throws WTException


Supported API: false

Parameters:
listKey -
Returns:
List
Throws:
WTException

initializeScript

public void initializeScript(WTContainerRef sourceCont,
                             String scriptId)
                      throws WTException


Supported API: false

Parameters:
sourceCont -
scriptId -
Throws:
WTException