oracle.ifs.protocols.commands

Class IfsDoesPublicObjectExistByIdCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsDoesPublicObjectExistByIdCommand

All Implemented Interfaces:

Command

public class IfsDoesPublicObjectExistByIdCommand
extends IfsCommand

A IfsDoesPublicObjectExistByIdCommand is the command to determine whether a PublicObject exist by specifying its id. If exist, 'true' will be returned; 'false' otherwise.

Command specification for IfsDoesPublicObjectExistByIdCommand
Inputs:

• session : LibrarySession (required)
• id : Long (required)

Outputs :

• results : boolean

Description:

• Find a PublicObject by specifying its id.
• If found, return 'true'; else return 'false'.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsDoesPublicObjectExistByIdCommand() Defualt 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(DoesPublicObjectExistByIdContext context) Execute a DoesPublicObjectExistByIdContext.
protected IfsFindPublicObjectByIdCommand	getFindPOByIdCommand() Return an instance of the IfsFindPublicObjectByIdCommand.
void	populateNestedCommands(CommandInvoker invoker) Populate the required nested commands.
protected PublicObject	runFindPOByIdCommand(LibrarySession session, Long id) Execute an IfsFindPublicObjectByIdCommand.

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

IfsDoesPublicObjectExistByIdCommand

public IfsDoesPublicObjectExistByIdCommand()

Defualt Constructor

(Published)

Method Detail

populateNestedCommands

public void populateNestedCommands(CommandInvoker invoker)
                            throws IfsException

Populate the required nested commands. In this command, we need IfsFindPublicObjectByIdCommand.

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(DoesPublicObjectExistByIdContext context)
                throws IfsException

Execute a DoesPublicObjectExistByIdContext.

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)

runFindPOByIdCommand

protected PublicObject runFindPOByIdCommand(LibrarySession session,
                                            Long id)
                                     throws IfsException

Execute an IfsFindPublicObjectByIdCommand. It takes in all inputs that are required to run IfsFindPublicObjectByIdCommand.

Returns:

PublicObject

Throws:

IfsException

See Also:

IfsFindPublicObjectByIdCommand

(Unpublished)

getFindPOByIdCommand

protected IfsFindPublicObjectByIdCommand getFindPOByIdCommand()
                                                       throws IfsException

Return an instance of the IfsFindPublicObjectByIdCommand.

Returns:

IfsFindPublicObjectByIdCommand.

Throws:

IfsException

(Unpublished)