oracle.ifs.protocols.commands

Class IfsCheckOutCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsCheckOutCommand

All Implemented Interfaces:

Command

public class IfsCheckOutCommand
extends IfsCommand

A IfsCheckOutCommand is used to check out a document. If the document is already checked out, an IfsException will be thrown.

Command specification for IfsCheckOutCommand

Inputs:

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

Outputs :

• publicobject : PublicObject

Description:

• Reserve the vs.
• If vs is already reserved, an IfsException(68031) will be thrown.
• Return the latest version in vs.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsCheckOutCommand() Defualt Constructor

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected void	execute(CheckOutContext context) Execute a CheckOutContext.
protected void	execute(CommandContext context) Execute a CommandContext.

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

populateNestedCommands, postExecute, preExecute, run

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IfsCheckOutCommand

public IfsCheckOutCommand()

Defualt Constructor

(Published)

Method Detail

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

Execute a CheckOutContext.

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)