oracle.ifs.protocols.commands

Class IfsShowAllPathsCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsShowAllPathsCommand

All Implemented Interfaces:

Command

public class IfsShowAllPathsCommand
extends IfsCommand

An IfsShowAllPathsCommand is a command that given a LibraryObject, an array of all the paths to that object is returned. Inputs:

• session : LibrarySession (required)
• lo : LibraryObject (required)

Outputs :

• paths : String[]

Description:

• Gets all the paths to the LibraryObject using the method, getAllFolderPaths(). The LibraryObject must be an instance of PublicObject. An array of folder paths is returned.

Version:

0.9

Author:

Tina Seto

See Also:

IfsCommand

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsShowAllPathsCommand() Default Constructor

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected void	execute(CommandContext context) Execute a CommandContext.
protected void	execute(ShowAllPathsContext context) Executes a ShowAllPathsContext.

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

populateNestedCommands, postExecute, preExecute, run

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsShowAllPathsCommand

public IfsShowAllPathsCommand()

Default Constructor

(Published)

Method Detail

execute

protected void execute(CommandContext context)
                throws IfsException

Execute a CommandContext.

Overrides:

execute in class IfsCommand

Parameters:

context - the command context.

Throws:

IfsException - if the operation fails

(Published)

execute

protected void execute(ShowAllPathsContext context)
                throws IfsException

Executes a ShowAllPathsContext. This gets all folder paths to the target object starting from the root folder.

Throws:

IfsException - if the operation fails

(Published)

createCommandContext

public CommandContext createCommandContext()
                                    throws IfsException

Returns a CommandContext to be used throughout the invocation.

Specified by:

createCommandContext in interface Command

Overrides:

createCommandContext in class IfsCommand

Returns:

the command context

Throws:

IfsException - if the operation fails

See Also:

CommandContext

(Published)