oracle.ifs.protocols.commands

Class IfsShowAllPathsContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsShowAllPathsContext

All Implemented Interfaces:

ShowAllPathsContext, CommandContext

public class IfsShowAllPathsContext
extends IfsCommandContext
implements ShowAllPathsContext

IfsShowAllPathsContext implements context for the show all paths command.

Version:

0.9

Author:

Tina Seto

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsShowAllPathsContext() Default Constructor.
IfsShowAllPathsContext(LibrarySession session, LibraryObject obj) Constructor which sets up all the required parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
String[]	getAllPaths() Gets all folder paths to the target object starting from the root folder.
LibraryObject	getLibraryObject() Gets the target object.
LibrarySession	getLibrarySession() Gets the LibrarySession.
void	setAllPaths(String[] paths) Sets the string array of folder paths.
void	setLibraryObject(LibraryObject lo) Sets the target object.
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

IfsShowAllPathsContext

public IfsShowAllPathsContext()
                       throws IfsException

Default Constructor.

Throws:

IfsException - if the operation fails

(Published)

IfsShowAllPathsContext

public IfsShowAllPathsContext(LibrarySession session,
                              LibraryObject obj)
                       throws IfsException

Constructor which sets up all the required parameters.

Parameters:

session - LibrarySession instance to execute the command

Throws:

IfsException - if the operation fails

(Published)

Method Detail

clear

public void clear()

Clears the Context. Does not throw.

Specified by:

clear in interface ShowAllPathsContext

Specified by:

clear in interface CommandContext

Overrides:

clear in class IfsCommandContext

(Published)

getLibrarySession

public LibrarySession getLibrarySession()
                                 throws IfsException

Gets the LibrarySession.

Specified by:

getLibrarySession in interface ShowAllPathsContext

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 ShowAllPathsContext

Parameters:

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

Throws:

IfsException - if the operation fails

(Published)

getAllPaths

public String[] getAllPaths()
                     throws IfsException

Gets all folder paths to the target object starting from the root folder. If no paths exist, returns null.

Specified by:

getAllPaths in interface ShowAllPathsContext

Returns:

string array of folder paths

Throws:

IfsException - if the operation fails

(Published)

setAllPaths

public void setAllPaths(String[] paths)
                 throws IfsException

Sets the string array of folder paths.

Specified by:

setAllPaths in interface ShowAllPathsContext

Throws:

IfsException - if the operation fails

(Published)

getLibraryObject

public LibraryObject getLibraryObject()
                               throws IfsException

Gets the target object.

Specified by:

getLibraryObject in interface ShowAllPathsContext

Returns:

the LibraryObject

Throws:

IfsException - if the operation fails.

(Published)

setLibraryObject

public void setLibraryObject(LibraryObject lo)
                      throws IfsException

Sets the target object.

Specified by:

setLibraryObject in interface ShowAllPathsContext

Parameters:

lo - the LibraryObject

Throws:

IfsException - if the operation fails.

(Published)