oracle.ifs.protocols.cup.commands

Class CupRmArgumentTranslator

java.lang.Object

oracle.ifs.protocols.commands.utils.CommandlineArgumentTranslator

oracle.ifs.protocols.cup.commands.CupArgumentTranslator

oracle.ifs.protocols.cup.commands.CupRmArgumentTranslator

All Implemented Interfaces:

ArgumentTranslator

public class CupRmArgumentTranslator
extends CupArgumentTranslator

CupRmArgumentTranslator handles the positionals that cup uses during the RM Command.

Version:

1.0

Author:

Vijayanth Devadhar

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	FLAG_RECURSIVE String representing the recursive flag.

Fields inherited from class oracle.ifs.protocols.cup.commands.CupArgumentTranslator

FLAG_CLASS, FLAG_ID, FLAG_PATH, FLAG_SYSTEMACL, FLAG_USER, FLAG_VALUEDEFAULT, PARAMETER_FLAGKEY, PARAMETER_FLAGVALUE, PARAMETER_POSITIONAL

Fields inherited from class oracle.ifs.protocols.commands.utils.CommandlineArgumentTranslator

CMDKEY

Constructor Summary

Constructors

Constructor and Description
CupRmArgumentTranslator()

Method Summary

Modifier and Type	Method and Description
protected int[]	getPotentialArgs() Gets the argument type a particular flag is expecting.
protected String[]	getPotentialFlags() Gets the potentails flags that the object might be expecting.
protected void	handleFlag(String flagKey, String flagValue, CommandContext state, Hashtable tstate) Handles a flags and arguments in the command line.
protected void	initialize(CommandContext state, Object invoker, Hashtable tstate) Initialize the argument translator.
protected void	postParse(CommandContext state, Object invoker, Hashtable tstate) Sets up the DeleteLibraryObjectContext with parameters required
protected FolderDefinition	resolveDefinition(CommandContext state, Object invoker, Hashtable tstate, LibraryObject lo) Creates a FolderDefinition if we need to one to be used with RM command.

Methods inherited from class oracle.ifs.protocols.cup.commands.CupArgumentTranslator

handlePositional, resolveObject

Methods inherited from class oracle.ifs.protocols.commands.utils.CommandlineArgumentTranslator

parse, translate

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_RECURSIVE

protected final String FLAG_RECURSIVE

String representing the recursive flag.

See Also:

Constant Field Values

(Published)

Constructor Detail

CupRmArgumentTranslator

public CupRmArgumentTranslator()

Method Detail

initialize

protected void initialize(CommandContext state,
                          Object invoker,
                          Hashtable tstate)
                   throws IfsException

Initialize the argument translator. Setting up argument hashtable with default values for arguments is done here. Add to tstate hashtable any specific parameters taht are handled by the base class.

Overrides:

initialize in class CupArgumentTranslator

Parameters:

state - instance of CommandContext

invoker - invoker of this command; usually CupServerChannel

tstate - hashtable used to store flags

Throws:

IfsException - if the operation fails

(Published)

postParse

protected void postParse(CommandContext state,
                         Object invoker,
                         Hashtable tstate)
                  throws IfsException

Sets up the DeleteLibraryObjectContext with parameters required

Overrides:

postParse in class CommandlineArgumentTranslator

Parameters:

state - instance of CommandContext

invoker - invoker of this command; usually CupServerChannel

tstate - hashtable used to store flags

Throws:

IfsException - if the operation fails

(Published)

getPotentialFlags

protected String[] getPotentialFlags()

Gets the potentails flags that the object might be expecting.

Overrides:

getPotentialFlags in class CupArgumentTranslator

Returns:

String[] arry of String objects representing flags

(Published)

getPotentialArgs

protected int[] getPotentialArgs()

Gets the argument type a particular flag is expecting.

Overrides:

getPotentialArgs in class CupArgumentTranslator

Returns:

int[] arry of String objects representing flags

(Published)

handleFlag

protected void handleFlag(String flagKey,
                          String flagValue,
                          CommandContext state,
                          Hashtable tstate)
                   throws IfsException

Handles a flags and arguments in the command line.

Overrides:

handleFlag in class CupArgumentTranslator

Parameters:

flagKey - key used to identify the flag in the command line

flagValue - value of the flag

state - instance of CommandContext object

tstate - hashtable which stores parameters

Throws:

IfsException - if the operation fails

(Published)

resolveDefinition

protected FolderDefinition resolveDefinition(CommandContext state,
                                             Object invoker,
                                             Hashtable tstate,
                                             LibraryObject lo)
                                      throws IfsException

Creates a FolderDefinition if we need to one to be used with RM command.

Parameters:

state - instance of CommandContext

invoker - invoker of this command; usually CupServerChannel

tstate - hashtable used to store flags

lo - LibraryObject being deleted

Throws:

IfsException - if the operation fails

(Published)