oracle.ifs.protocols.commands

Class IfsMvContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsMvContext

All Implemented Interfaces:

MvContext, CommandContext

public class IfsMvContext
extends IfsCommandContext
implements MvContext

IfsMvContext implements context for MV command.

Command specification for IfsMvCommand Inputs :

• po : PublicObject (required)
• source : Folder (required)
• destination : Folder (required)
• newname : String (required)

Output :

• NONE

Description :

• IfsMvCommand removes reference to the publicobject from the source folder and adds a reference in the destination folder with the newname. If the destination folder already has a reference with the newname, then versioning layer sub command will be invoked.

Version:

0.9

Author:

Vijayanth Devadhar

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsMvContext() Default constructor.
IfsMvContext(LibrarySession session, PublicObject po, Folder source, Folder destination, String newName) Constructor that takes all parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
Folder	getDestinationFolder() Gets the destination folder of the public object.
LibrarySession	getLibrarySession() Gets the LibrarySession.
String	getNewName() Gets the new name of the public object.
PublicObject	getPublicObject() Gets the public object which needs to be moved.
Folder	getSourceFolder() Gets the source folder of the public object.
void	setDestinationFolder(Folder destination) Sets the destination folder of this context.
void	setLibrarySession(LibrarySession session) Sets the LibrarySession.
void	setNewName(String name) Sets the new name of the public object.
void	setPublicObject(PublicObject po) Sets the public object that needs to be moved.
void	setSourceFolder(Folder source) Sets the source folder of this context.

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsMvContext

public IfsMvContext()
             throws IfsException

Default constructor.

Throws:

IfsException - if the operation fails.

(Published)

IfsMvContext

public IfsMvContext(LibrarySession session,
                    PublicObject po,
                    Folder source,
                    Folder destination,
                    String newName)
             throws IfsException

Constructor that takes all parameters.

Parameters:

session - instance of LibrarySession

po - Public Object for this command

source - source folder

destination - destination folder

newName - new name of the public object

Throws:

IfsException - if the operation fails.

(Published)

Method Detail

clear

public void clear()

Clears the Context. Does not throw.

Specified by:

clear in interface MvContext

Specified by:

clear in interface CommandContext

Overrides:

clear in class IfsCommandContext

(Published)

getPublicObject

public PublicObject getPublicObject()
                             throws IfsException

Gets the public object which needs to be moved.

Specified by:

getPublicObject in interface MvContext

Returns:

PublicObject public object instance of this context

Throws:

IfsException - if the operation fails

(Published)

setPublicObject

public void setPublicObject(PublicObject po)
                     throws IfsException

Sets the public object that needs to be moved.

Specified by:

setPublicObject in interface MvContext

Parameters:

po - public object for this context

Throws:

IfsException - if the operation fails

(Published)

getSourceFolder

public Folder getSourceFolder()
                       throws IfsException

Gets the source folder of the public object.

Specified by:

getSourceFolder in interface MvContext

Returns:

Folder source folder for the public object

Throws:

IfsException - if the operation fails

(Published)

setSourceFolder

public void setSourceFolder(Folder source)
                     throws IfsException

Sets the source folder of this context.

Specified by:

setSourceFolder in interface MvContext

Parameters:

source - source folder of the public object

Throws:

IfsException - if the operation fails

(Published)

getDestinationFolder

public Folder getDestinationFolder()
                            throws IfsException

Gets the destination folder of the public object.

Specified by:

getDestinationFolder in interface MvContext

Returns:

Folder destination folder for the public object

Throws:

IfsException - if the operation fails

(Published)

setDestinationFolder

public void setDestinationFolder(Folder destination)
                          throws IfsException

Sets the destination folder of this context.

Specified by:

setDestinationFolder in interface MvContext

Parameters:

destination - destination folder for the public object

Throws:

IfsException - if the operation fails

(Published)

getNewName

public String getNewName()
                  throws IfsException

Gets the new name of the public object.

Specified by:

getNewName in interface MvContext

Returns:

String new name for the public object

Throws:

IfsException - if the operation fails

(Published)

setNewName

public void setNewName(String name)
                throws IfsException

Sets the new name of the public object.

Specified by:

setNewName in interface MvContext

Parameters:

name - new name for the public object

Throws:

IfsException - if the operation fails

(Published)

getLibrarySession

public LibrarySession getLibrarySession()
                                 throws IfsException

Gets the LibrarySession.

Specified by:

getLibrarySession in interface MvContext

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 MvContext

Parameters:

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

Throws:

IfsException - if the operation fails

(Published)