oracle.ifs.protocols.commands

Class IfsDeleteLibraryObjectContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsDeleteLibraryObjectContext

All Implemented Interfaces:

DeleteLibraryObjectContext, CommandContext

public class IfsDeleteLibraryObjectContext
extends IfsCommandContext
implements DeleteLibraryObjectContext

IfsDeleteLibraryObjectContext implements context for delete library object command.

Command specification for IfsDeleteLibraryObjectCommand

Inputs:

• session : LibrarySession (required)
• lo : LibraryObject (required)
• loDef : LibraryObjectDefinition (optional)

Output:

• NONE

Description:

• For most IFS objects this results in LibraryObject.free(LibraryObjectDefinition). If the user passes a null definition, then command will construct a generic definition for Object types requiring special operations. For following objects, special operations necessary in case of delete and they cannot be deleted using this command.
  • MAILBOX, MAILFOLDER, MESSAGE
  • DIRECTORYUSER, USERPROFILE

Version:

0.9

Author:

Vijayanth Devadhar

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsDeleteLibraryObjectContext() Default Constructor.
IfsDeleteLibraryObjectContext(LibrarySession session, LibraryObject lo, LibraryObjectDefinition loDef) Constructor which sets up all the required parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
LibraryObject	getLibraryObject() Gets the LibraryObject.
LibraryObjectDefinition	getLibraryObjectDefinition() Gets the LibraryObjectDefinition.
String	getLibraryObjectPath() Gets the absolute path to the LibraryObject.
LibrarySession	getLibrarySession() Gets the LibrarySession.
void	setLibraryObject(LibraryObject lo) Sets the LibraryObject.
void	setLibraryObjectDefinition(LibraryObjectDefinition loDef) Sets the LibraryObjectDefinition.
void	setLibraryObjectPath(String path) Sets the absolute path to the LibraryObject.
void	setLibrarySession(LibrarySession session) Sets the LibrarySession.

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsDeleteLibraryObjectContext

public IfsDeleteLibraryObjectContext()
                              throws IfsException

Default Constructor.

Throws:

IfsException - if the operation fails

(Published)

IfsDeleteLibraryObjectContext

public IfsDeleteLibraryObjectContext(LibrarySession session,
                                     LibraryObject lo,
                                     LibraryObjectDefinition loDef)
                              throws IfsException

Constructor which sets up all the required parameters.

Parameters:

session - LibrarySession instance to execute the command

lo - instance of LibraryObject that needs to be removed

loDef - LibraryObjectDefinition that may carry the options to be used with delete

Throws:

IfsException - if the operation fails

(Published)

Method Detail

clear

public void clear()

Clears the Context. Does not throw.

Specified by:

clear in interface DeleteLibraryObjectContext

Specified by:

clear in interface CommandContext

Overrides:

clear in class IfsCommandContext

(Published)

getLibraryObject

public LibraryObject getLibraryObject()
                               throws IfsException

Gets the LibraryObject.

Specified by:

getLibraryObject in interface DeleteLibraryObjectContext

Returns:

LibraryObject LibraryObject of this context

Throws:

IfsException - if the operation fails

(Published)

setLibraryObject

public void setLibraryObject(LibraryObject lo)
                      throws IfsException

Sets the LibraryObject.

Specified by:

setLibraryObject in interface DeleteLibraryObjectContext

Parameters:

lo - LibraryObject for this context

Throws:

IfsException - if the operation fails

(Published)

getLibraryObjectDefinition

public LibraryObjectDefinition getLibraryObjectDefinition()
                                                   throws IfsException

Gets the LibraryObjectDefinition.

Specified by:

getLibraryObjectDefinition in interface DeleteLibraryObjectContext

Returns:

lodef LibraryObjectDefinition definition of this context.

Throws:

IfsException - if the operation fails

(Published)

setLibraryObjectDefinition

public void setLibraryObjectDefinition(LibraryObjectDefinition loDef)
                                throws IfsException

Sets the LibraryObjectDefinition.

Specified by:

setLibraryObjectDefinition in interface DeleteLibraryObjectContext

Parameters:

loDef - LibraryObjectDefinition 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 DeleteLibraryObjectContext

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 DeleteLibraryObjectContext

Parameters:

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

Throws:

IfsException - if the operation fails

(Published)

setLibraryObjectPath

public void setLibraryObjectPath(String path)
                          throws IfsException

Sets the absolute path to the LibraryObject.

Specified by:

setLibraryObjectPath in interface DeleteLibraryObjectContext

Parameters:

path - absolute path

Throws:

IfsException - if the operation fails

(Published)

getLibraryObjectPath

public String getLibraryObjectPath()
                            throws IfsException

Gets the absolute path to the LibraryObject.

Specified by:

getLibraryObjectPath in interface DeleteLibraryObjectContext

Returns:

String path

Throws:

IfsException - if the operation fails

(Published)