oracle.owb.foundation
Class CopyMoveManager

java.lang.Object
  |
  +--oracle.owb.foundation.CopyMoveManager

public class CopyMoveManager

extends java.lang.Object

CopyMoveManager contains operations to handle Component Copy/Move operations.

Field Summary

static boolean	isSameFolder Use only for the case of OMBCOPY within the same folder.
protected static CopyMoveManager	s_instance s_instance is the handle to the copy/move service.

Constructor Summary

protected

CopyMoveManager()

Method Summary

int	copyComponent(Component sourceComponent) Copy a Component object to the internal clipboard.
int	copyComponents(Component[] sourceComponents) Copy an array of Component objects to the internal clipboard.
void	deleteComponents(Component[] compArray) This method deletes all Component objects in the array being passed in.
static CopyMoveManager	getInstance() Return the singleton handle for this service.
int	pasteToFolder(Folder targetFolder, boolean isReplace) Paste contents from the internal clipboard.
int	pasteToFolder(Folder targetFolder, boolean isReplace, java.lang.String newName) Paste contents from the internal clipboard.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isSameFolder

public static boolean isSameFolder

Use only for the case of OMBCOPY within the same folder. Caller must set isSameFolder flag to true to allow 'Copy_of' prefixing for physical and logical names if there is duplicate.

s_instance

protected static CopyMoveManager s_instance

s_instance is the handle to the copy/move service.

Constructor Detail

CopyMoveManager

protected CopyMoveManager()

Method Detail

getInstance

public static CopyMoveManager getInstance()

Return the singleton handle for this service.

Returns:

A CopyMoveManager object representing the instance value

copyComponent

public int copyComponent(Component sourceComponent)

Copy a Component object to the internal clipboard.

Parameters:

sourceComponent - Component object to be copied.

Returns:

A numeric indicator of whether copy to clipboard was successful (0=success, 1=error, 2=warning).

copyComponents

public int copyComponents(Component[] sourceComponents)

Copy an array of Component objects to the internal clipboard.

Parameters:

sourceComponents - An array of Component objects to be copied.

Returns:

A numeric indicator of whether copy to clipboard was successful (0=success, 1=error, 2=warning).

pasteToFolder

public int pasteToFolder(Folder targetFolder,
                         boolean isReplace)
                  throws IncompatibleTargetException,
NameSpaceException,
InvalidFormatException,
LockException

Paste contents from the internal clipboard.

Parameters:

targetFolder - A Folder object into which clipboard Component object(s) will be pasted.

isReplace - A flag that allows replacement of existing object(s) when set to true.

Returns:

A numeric indicator of whether paste from clipboard was successful (0=success, 1=error, 2=warning).

Throws:

IncompatibleTargetException - if the target Folder is not a valid container for the type of object to be pasted.

NameSpaceException - if another OWBNamedObject with the same same name already exists within this object's namespace

InvalidFormatException - if the desired name does not satisfy the format requirements.

LockException - if the lock could not be obtained on an object to be replaced.

pasteToFolder

public int pasteToFolder(Folder targetFolder,
                         boolean isReplace,
                         java.lang.String newName)
                  throws IncompatibleTargetException,
NameSpaceException,
InvalidFormatException,
LockException

Paste contents from the internal clipboard.

Parameters:

targetFolder - A Folder object into which clipboard Component object(s) will be pasted.

isReplace - A flag that allows replacement of existing object(s) when set to true.

newName - The name to be assigned to the pasted object, if the source object name default is not desired. Only valid when pasting a single object.

Returns:

A numeric indicator of whether paste from clipboard was successful (0=success, 1=error, 2=warning).

Throws:

IncompatibleTargetException - if the target Folder is not a valid container for the type of object to be pasted.

NameSpaceException - if another OWBNamedObject with the same same name already exists within this object's namespace

InvalidFormatException - if the desired name does not satisfy the format requirements.

LockException - if the lock could not be obtained on an object to be replaced.

deleteComponents

public void deleteComponents(Component[] compArray)

This method deletes all Component objects in the array being passed in.

Parameters:

compArray - An array of Component objects to be deleted, cannot be null.