oracle.ifs.protocols.commands

Interface CopyContext

All Superinterfaces:

CommandContext

All Known Implementing Classes:

IfsCopyContext

public interface CopyContext
extends CommandContext

CopyContext encapsulates the context of a CopyCommand.

Version:

0.9

Author:

Tina Seto

(Unpublished)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
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.

Method Detail

clear

void clear()

Clears the Context. Does not throw.

Specified by:

clear in interface CommandContext

(Published)

getLibrarySession

LibrarySession getLibrarySession()
                          throws IfsException

Gets the LibrarySession.

Returns:

LibrarySession session of this command context

Throws:

IfsException - if the operation fails

(Published)

setLibrarySession

void setLibrarySession(LibrarySession session)
                throws IfsException

Sets the LibrarySession.

Parameters:

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

Throws:

IfsException - if the operation fails

(Published)

getDestinationParentFolder

Folder getDestinationParentFolder()
                           throws IfsException

Gets the parent folder of the new object.

Returns:

Folder parent destination folder

Throws:

IfsException - if the operation fails

(Published)

setDestinationParentFolder

void setDestinationParentFolder(Folder dest)
                         throws IfsException

Sets the parent folder of the new object.

Parameters:

dest - parent folder

Throws:

IfsException - if the operation fails

(Published)

getSourcePublicObject

PublicObject getSourcePublicObject()
                            throws IfsException

Gets the PublicObject from which the new object is copied.

Returns:

PublicObject source object

Throws:

IfsException - if the operation fails

(Published)

setSourcePublicObject

void setSourcePublicObject(PublicObject src)
                    throws IfsException

Sets the PublicObject from which the new object is copied.

Parameters:

src - source object

Throws:

IfsException - if the operation fails

(Published)

getNewName

String getNewName()
           throws IfsException

Gets the name of the new object.

Returns:

String name

Throws:

IfsException - if the operation fails

(Published)

setNewName

void setNewName(String name)
         throws IfsException

Sets the name of the new object.

Parameters:

name - new copy name

Throws:

IfsException - if the operation fails

(Published)

getOverwriteFlag

boolean getOverwriteFlag()
                  throws IfsException

Gets the overwrite flag.

Returns:

true if should overwrite objects with duplicate name.

Throws:

IfsException - if the operation fails

(Published)

setOverwriteFlag

void setOverwriteFlag(boolean flag)
               throws IfsException

Sets the overwrite flag

Parameters:

flag - true or false

Throws:

IfsException - if the operation fails

(Published)