IfsDoesPublicObjectExistByPathCommand (ecmsdk-api 3.7.0 API)

java.lang.Object
- oracle.ifs.protocols.commands.utils.IfsCommand
- - oracle.ifs.protocols.commands.IfsDoesPublicObjectExistByPathCommand

All Implemented Interfaces:

Command
```
public class IfsDoesPublicObjectExistByPathCommand
extends IfsCommand
```
A IfsDoesPublicObjectExistByPathCommand is the command to determine whether a PublicObject exist by specifying a path. If exist, 'true' will be returned; 'false' otherwise.
Command specification for IfsDoesPublicObjectExistByPathCommand
Inputs:
- session : LibrarySession (required)
- path : String (required)
- fpr : FolderPathResolver (optional)
Outputs :
- results : boolean
Description:
- Find a PublicObject by specifying a path.
- If fpr is specified, relative path can be specified, and relative path search will start with the current path specified in fpr.
- If fpr is not specified, only absolte path can be specified.
If found, return 'true'; else return 'false'.

Version:: 0.9
Author:: Patricia Li
(Unpublished)

Constructor Summary

Constructors
Constructor and Description

IfsDoesPublicObjectExistByPathCommand()
Defualt Constructor

Constructors
Constructor and Description
`IfsDoesPublicObjectExistByPathCommand()` Defualt Constructor

Method Summary

All Methods Instance Methods Concrete Methods
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(DoesPublicObjectExistByPathContext context)` Execute a DoesPublicObjectExistByPathContext.
`protected IfsFindPublicObjectByPathCommand`	`getFindPOByPathCommand()` Return an instance of the IfsFindPublicObjectByPathCommand.
`void`	`populateNestedCommands(CommandInvoker invoker)` Populate the required nested commands.
`protected PublicObject`	`runFindPOByPathCommand(LibrarySession session, String path, FolderPathResolver fpr)` Execute an IfsFindPublicObjectByPathCommand.

Methods inherited from class oracle.ifs.protocols.commands.utils.IfsCommand
postExecute, preExecute, run

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IfsDoesPublicObjectExistByPathCommand
```
public IfsDoesPublicObjectExistByPathCommand()
```
    Defualt Constructor
    
    (Published)
- Method Detail
  - populateNestedCommands
```
public void populateNestedCommands(CommandInvoker invoker)
                            throws IfsException
```
    Populate the required nested commands. In this command, we need IfsFindPublicObjectByPathCommand.
    
    Specified by:
    
    populateNestedCommands in interface Command
    
    Overrides:
    
    populateNestedCommands in class IfsCommand
    
    Parameters:
    
    invoker - Command invoker object.
    
    Throws:
    
    IfsException - If there is any exception thrown.
    
    See Also:
    
    CommandInvoker
    
    (Published)
  - execute
```
protected void execute(CommandContext context)
                throws IfsException
```
    Execute a CommandContext.
    
    Overrides:
    
    execute in class IfsCommand
    
    Parameters:
    
    context - The command context.
    
    Throws:
    
    IfsException - if execution fails
    
    (Published)
  - execute
```
protected void execute(DoesPublicObjectExistByPathContext context)
                throws IfsException
```
    Execute a DoesPublicObjectExistByPathContext.
    
    Parameters:
    
    context - The command context.
    
    Throws:
    
    IfsException
    
    (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:
    
    CommandContext
    
    Throws:
    
    IfsException
    
    See Also:
    
    CommandContext
    
    (Published)
  - runFindPOByPathCommand
```
protected PublicObject runFindPOByPathCommand(LibrarySession session,
                                              String path,
                                              FolderPathResolver fpr)
                                       throws IfsException
```
    Execute an IfsFindPublicObjectByPathCommand. It takes in all inputs that are required to run IfsFindPublicObjectByPathCommand.
    
    Returns:
    
    PublicObject
    
    Throws:
    
    IfsException
    
    See Also:
    
    IfsFindPublicObjectByPathCommand
    
    (Unpublished)
  - getFindPOByPathCommand
```
protected IfsFindPublicObjectByPathCommand getFindPOByPathCommand()
                                                           throws IfsException
```
    Return an instance of the IfsFindPublicObjectByPathCommand.
    
    Returns:
    
    IfsFindPublicObjectByPathCommand.
    
    Throws:
    
    IfsException
    
    (Unpublished)

Class IfsDoesPublicObjectExistByPathCommand

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

IfsDoesPublicObjectExistByPathCommand

Method Detail

populateNestedCommands

execute

execute

createCommandContext

runFindPOByPathCommand

getFindPOByPathCommand