oracle.ifs.protocols.commands

Class IfsCancelCheckOutCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsCancelCheckOutCommand

All Implemented Interfaces:

Command

public class IfsCancelCheckOutCommand
extends IfsCommand

A IfsCancelCheckOutCommand is the command to cancel checkout on a document.

Command specification for IfsCancelCheckOutCommand
Inputs:

• session : LibrarySession (required)
• vs : VersionSeries (required)

Outputs :

• NONE

Description:

• Unreserve the VersionSeries.
• If not checked out, an IfsException(68032) will be thrown (IfsIsCheckedOutCommand is called).
• The PendingPublicObject will be deleted if it exists.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsCancelCheckOutCommand() Defualt Constructor

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected void	execute(CancelCheckOutContext context) Execute a CancelCheckOutContext.
protected void	execute(CommandContext context) Execute a CommandContext.
protected IfsCheckedOutByCommand	getCheckedOutByCommand() Return an instance of the IfsCheckedOutByCommand.
protected IfsGetCurrentUserCommand	getGetCurrentUserCommand() Return an instance of the IfsGetCurrentUserCommand.
void	populateNestedCommands(CommandInvoker invoker) Populate the required nested commands.
protected DirectoryUser	runCheckedOutByCommand(LibrarySession session, VersionSeries vs) Execute an IfsCheckedOutByCommand.
protected DirectoryUser	runGetCurrentUserCommand(LibrarySession session) Execute an IfsGetCurrentUserCommand.

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

IfsCancelCheckOutCommand

public IfsCancelCheckOutCommand()

Defualt Constructor

(Published)

Method Detail

populateNestedCommands

public void populateNestedCommands(CommandInvoker invoker)
                            throws IfsException

Populate the required nested commands. In this command, we need IfsCheckedOutByCommand and IfsGetCurrentUserCommand.

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

Execute a CancelCheckOutContext.

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)

runCheckedOutByCommand

protected DirectoryUser runCheckedOutByCommand(LibrarySession session,
                                               VersionSeries vs)
                                        throws IfsException

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

Returns:

DirectoryUser.

Throws:

IfsException

See Also:

IfsCheckedOutByCommand

(Unpublished)

getCheckedOutByCommand

protected IfsCheckedOutByCommand getCheckedOutByCommand()
                                                 throws IfsException

Return an instance of the IfsCheckedOutByCommand.

Returns:

IfsCheckedOutByCommand.

Throws:

IfsException

(Unpublished)

runGetCurrentUserCommand

protected DirectoryUser runGetCurrentUserCommand(LibrarySession session)
                                          throws IfsException

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

Returns:

DirectoryUser.

Throws:

IfsException

See Also:

IfsGetCurrentUserCommand

(Unpublished)

getGetCurrentUserCommand

protected IfsGetCurrentUserCommand getGetCurrentUserCommand()
                                                     throws IfsException

Return an instance of the IfsGetCurrentUserCommand.

Returns:

IfsGetCurrentUserCommand.

Throws:

IfsException

(Unpublished)