oracle.ifs.protocols.commands

Class IfsAddFolderRelationshipContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsAddFolderRelationshipContext

All Implemented Interfaces:

AddFolderRelationshipContext, CommandContext

public class IfsAddFolderRelationshipContext
extends IfsCommandContext
implements AddFolderRelationshipContext

IfsAddFolderRelationshipContext implements context for add reference command. Command specification for IfsAddFolderRelationshipCommand

Inputs:

• session : LibrarySession (required)
• folder : Folder (required)
• po : PublicObject (required)

Outputs :

• NONE

Description:

• Takes a Folder and a PublicObject. Calls addItem() on Folder and passes the PublicObject to it. This command calls the versioning layer sub command if the Folder already had an item with the same name as that of the PublicObject.

Version:

0.9

Author:

Vijayanth Devadhar

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsAddFolderRelationshipContext() Default Constructor.
IfsAddFolderRelationshipContext(LibrarySession session, Folder folder, PublicObject publicObject) Constructor which sets up all the required parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
Folder	getFolder() Gets the Folder.
LibrarySession	getLibrarySession() Gets the LibrarySession.
PublicObject	getPublicObject() Gets the PublicObject.
void	setFolder(Folder folder) Sets the Folder.
void	setLibrarySession(LibrarySession session) Sets the LibrarySession.
void	setPublicObject(PublicObject publicObject) Sets the PublicObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsAddFolderRelationshipContext

public IfsAddFolderRelationshipContext()
                                throws IfsException

Default Constructor.

Throws:

IfsException - if the operation fails

(Published)

IfsAddFolderRelationshipContext

public IfsAddFolderRelationshipContext(LibrarySession session,
                                       Folder folder,
                                       PublicObject publicObject)
                                throws IfsException

Constructor which sets up all the required parameters.

Parameters:

session - LibrarySession instance to execute the command

folder - the destination folder

publicObject - instance of PublicObject that needs to be added to the folder

Throws:

IfsException - ifs the operation fails

(Published)

Method Detail

clear

public void clear()

Clears the Context. Does not throw.

Specified by:

clear in interface CommandContext

Overrides:

clear in class IfsCommandContext

(Published)

getFolder

public Folder getFolder()
                 throws IfsException

Gets the Folder.

Specified by:

getFolder in interface AddFolderRelationshipContext

Returns:

Folder destination folder in this context

Throws:

IfsException - if the operation fails

(Published)

setFolder

public void setFolder(Folder folder)
               throws IfsException

Sets the Folder.

Specified by:

setFolder in interface AddFolderRelationshipContext

Parameters:

folder - destination folder

Throws:

IfsException - if the operation fails

(Published)

getPublicObject

public PublicObject getPublicObject()
                             throws IfsException

Gets the PublicObject.

Specified by:

getPublicObject in interface AddFolderRelationshipContext

Returns:

PublicObject public object for this context.

Throws:

IfsException - if the operation fails

(Published)

setPublicObject

public void setPublicObject(PublicObject publicObject)
                     throws IfsException

Sets the PublicObject.

Specified by:

setPublicObject in interface AddFolderRelationshipContext

Parameters:

publicObject - instance of PublicObject to be used in this context

Throws:

IfsException - if the operation fails

(Published)

getLibrarySession

public LibrarySession getLibrarySession()
                                 throws IfsException

Gets the LibrarySession.

Specified by:

getLibrarySession in interface AddFolderRelationshipContext

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 AddFolderRelationshipContext

Parameters:

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

Throws:

IfsException - if the operation fails

(Published)