oracle.ifs.protocols.commands

Interface ShowAllPathsContext

All Superinterfaces:

CommandContext

All Known Implementing Classes:

IfsShowAllPathsContext

public interface ShowAllPathsContext
extends CommandContext

ShowAllPathsContext interface encapsulates context for the show all paths command.

Version:

0.9

Author:

Tina Seto

(Unpublished)

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 po) Sets the target object.
void	setLibrarySession(LibrarySession session) Sets the LibrarySession.

Method Detail

clear

void clear()

Clears the Context. Does not throw.

Specified by:

clear in interface CommandContext

(Published)

getLibrarySession

LibrarySession getLibrarySession()
                          throws IfsException

Gets the LibrarySession.

Returns:

LibrarySession session of this command context

Throws:

IfsException - if the operation fails

(Published)

setLibrarySession

void setLibrarySession(LibrarySession session)
                throws IfsException

Sets the LibrarySession.

Parameters:

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

Throws:

IfsException - if the operation fails

(Published)

getAllPaths

String[] getAllPaths()
              throws IfsException

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

Returns:

string array of folder paths

Throws:

IfsException - if the operation fails

(Published)

setAllPaths

void setAllPaths(String[] paths)
          throws IfsException

Sets the string array of folder paths.

Throws:

IfsException - if the operation fails

(Published)

getLibraryObject

LibraryObject getLibraryObject()
                        throws IfsException

Gets the target object.

Returns:

the LibraryObject

Throws:

IfsException - if the operation fails.

(Published)

setLibraryObject

void setLibraryObject(LibraryObject po)
               throws IfsException

Sets the target object.

Parameters:

po - the LibraryObject

Throws:

IfsException - if the operation fails.

(Published)