oracle.ifs.protocols.commands

Class IfsCheckInCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsCheckInCommand

All Implemented Interfaces:

Command

public class IfsCheckInCommand
extends IfsCommand

A IfsCheckInCommand is the command to check in a document.

Command specification for IfsCheckInCommand

Inputs:

• session : LibrarySession (required)
• vs : VersionSeries (required)
• comment : String (optional)

Outputs :

• NONE

Description:

• Check in a document.
• If not checked out, an IfsException(68032) will be thrown (IfsIsCheckedOutCommand is called).
• If there exists a PendingPublicObject, a new version will be created in the vs with the PendingPublicObject.
• If there is no PendingPublicObject, a new version will be created with the content of the last version.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsCheckInCommand() Defualt Constructor

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected void	execute(CheckInContext context) Execute a CheckInContext.
protected void	execute(CommandContext context) Execute a CommandContext.
protected IfsIsCheckedOutCommand	getIsCheckedOutCommand() Return an instance of the IfsIsCheckedOutCommand.
void	populateNestedCommands(CommandInvoker invoker) Populate the required nested commands.
protected boolean	runIsCheckedOutCommand(LibrarySession session, VersionSeries vs) Execute an IfsIsCheckedOutCommand.

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

IfsCheckInCommand

public IfsCheckInCommand()

Defualt Constructor

(Published)

Method Detail

populateNestedCommands

public void populateNestedCommands(CommandInvoker invoker)
                            throws IfsException

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

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

Execute a CheckInContext.

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)

runIsCheckedOutCommand

protected boolean runIsCheckedOutCommand(LibrarySession session,
                                         VersionSeries vs)
                                  throws IfsException

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

Returns:

boolean.

Throws:

IfsException

See Also:

IfsIsCheckedOutCommand

(Unpublished)

getIsCheckedOutCommand

protected IfsIsCheckedOutCommand getIsCheckedOutCommand()
                                                 throws IfsException

Return an instance of the IfsIsCheckedOutCommand.

Returns:

IfsIsCheckedOutCommand.

Throws:

IfsException

(Unpublished)