oracle.ifs.protocols.commands

Class IfsCopyContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsCopyContext

All Implemented Interfaces:

CopyContext, CommandContext

public class IfsCopyContext
extends IfsCommandContext
implements CopyContext

IfsCopyContext is the base implementation of a CopyContext.

Version:

0.9

Author:

Tina Seto

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsCopyContext() The Constructor.
IfsCopyContext(LibrarySession session, PublicObject srcPO, Folder destFolder, String newName, boolean overwrite) Other Constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the CommandState. does not throw.
Folder	getDestinationParentFolder() Gets the parent folder of the new object.
LibrarySession	getLibrarySession() Gets the LibrarySession.
String	getNewName() Gets the name of the new object.
boolean	getOverwriteFlag() Gets the overwrite flag.
PublicObject	getSourcePublicObject() Gets the PublicObject from which the new object is copied.
void	setDestinationParentFolder(Folder dest) Sets the parent folder of the new object.
void	setLibrarySession(LibrarySession session) Sets the LibrarySession.
void	setNewName(String name) Sets the name of the new object.
void	setOverwriteFlag(boolean flag) Sets the overwrite flag
void	setSourcePublicObject(PublicObject src) Sets the PublicObject from which the new object is copied.

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsCopyContext

public IfsCopyContext()
               throws IfsException

The Constructor.

Throws:

IfsException

(Published)

IfsCopyContext

public IfsCopyContext(LibrarySession session,
                      PublicObject srcPO,
                      Folder destFolder,
                      String newName,
                      boolean overwrite)
               throws IfsException

Other Constructor.

Throws:

IfsException

(Published)

Method Detail

clear

public void clear()

Clears the CommandState. does not throw.

Specified by:

clear in interface CopyContext

Specified by:

clear in interface CommandContext

Overrides:

clear in class IfsCommandContext

(Published)

getLibrarySession

public LibrarySession getLibrarySession()
                                 throws IfsException

Gets the LibrarySession.

Specified by:

getLibrarySession in interface CopyContext

Returns:

LibrarySession session of this command context

Throws:

IfsException - if the operation fails

(Published)

setLibrarySession

public void setLibrarySession(LibrarySession session)
                       throws IfsException

Sets the LibrarySession.

Specified by:

setLibrarySession in interface CopyContext

Parameters:

session - instance of LibrarySession to be used in this command context

Throws:

IfsException - if the operation fails

(Published)

getDestinationParentFolder

public Folder getDestinationParentFolder()
                                  throws IfsException

Gets the parent folder of the new object.

Specified by:

getDestinationParentFolder in interface CopyContext

Returns:

Folder parent destination folder

Throws:

IfsException - if the operation fails

(Published)

setDestinationParentFolder

public void setDestinationParentFolder(Folder dest)
                                throws IfsException

Sets the parent folder of the new object.

Specified by:

setDestinationParentFolder in interface CopyContext

Parameters:

dest - parent folder

Throws:

IfsException - if the operation fails

(Published)

getSourcePublicObject

public PublicObject getSourcePublicObject()
                                   throws IfsException

Gets the PublicObject from which the new object is copied.

Specified by:

getSourcePublicObject in interface CopyContext

Returns:

PublicObject source object

Throws:

IfsException - if the operation fails

(Published)

setSourcePublicObject

public void setSourcePublicObject(PublicObject src)
                           throws IfsException

Sets the PublicObject from which the new object is copied.

Specified by:

setSourcePublicObject in interface CopyContext

Parameters:

src - source object

Throws:

IfsException - if the operation fails

(Published)

getNewName

public String getNewName()
                  throws IfsException

Gets the name of the new object.

Specified by:

getNewName in interface CopyContext

Returns:

String name

Throws:

IfsException - if the operation fails

(Published)

setNewName

public void setNewName(String name)
                throws IfsException

Sets the name of the new object.

Specified by:

setNewName in interface CopyContext

Parameters:

name - new copy name

Throws:

IfsException - if the operation fails

(Published)

getOverwriteFlag

public boolean getOverwriteFlag()
                         throws IfsException

Gets the overwrite flag.

Specified by:

getOverwriteFlag in interface CopyContext

Returns:

true if should overwrite objects with duplicate name.

Throws:

IfsException - if the operation fails

(Published)

setOverwriteFlag

public void setOverwriteFlag(boolean flag)
                      throws IfsException

Sets the overwrite flag

Specified by:

setOverwriteFlag in interface CopyContext

Parameters:

flag - true or false

Throws:

IfsException - if the operation fails

(Published)