oracle.ifs.protocols.commands

Class IfsHandlePublicObjectVersioningCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsHandlePublicObjectVersioningCommand

All Implemented Interfaces:

Command

public class IfsHandlePublicObjectVersioningCommand
extends IfsCommand

A IfsHandlePublicObjectVersioningCommand is the default way of adding a Document (or subclass of Document) to a Folder with proper versioning semantics:

Command specification for IfsHandlePublicObjectVersioningCommand

Inputs:

• session : LibrarySession (required)
• po : PublicObject (required)
• folder : Folder (required)
• comment : String (optional)

Outputs :

• NONE

Description:

• Adds a po (or subclass of po) to a Folder.
• If po is a Document (or subclass of Document), po will be added with proper versioning semantics. Else, an IfsException(68029) will be thrown.
• comment is only used if a check-in will be performed by the versioning layer.
• If there is an existing Document in folder with same name:
  • If existing Document is versioned:
    • If Document is checked out by the current user:
      • only one new version is created upon checkin (only the last update call before check in has any permanent effect)
    • If Document is checked out by another user:
      • an exception is thrown.
    • If Document is not checked out:
      • a new version is created with new content.
  • If exising Document is unversioned:
    • it is overwritten with the new Document.
• If there is no existing Document in folder with same name:
  • Document will be added to the folder.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsHandlePublicObjectVersioningCommand() Default 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(HandlePublicObjectVersioningContext context) Execute a HandlePublicObjectVersioningContext.
protected IfsCheckedOutByCommand	getCheckedOutByCommand() Return an instance of the IfsCheckedOutByCommand.
protected IfsCheckInCommand	getCheckInCommand() Return an instance of the IfsCheckInCommand.
protected IfsCheckOutCommand	getCheckOutCommand() Return an instance of the IfsCheckOutCommand.
void	populateNestedCommands(CommandInvoker invoker) Populate the required nested commands.
protected DirectoryUser	runCheckedOutByCommand(LibrarySession session, VersionSeries vs) Execute an IfsCheckedOutByCommand.
protected void	runCheckInCommand(LibrarySession session, PublicObject newVersionObject, VersionSeries vs, String comment) Execute an IfsCheckInCommand.
protected void	runCheckOutCommand(LibrarySession session, VersionSeries vs) Execute an IfsCheckOutCommand.

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

IfsHandlePublicObjectVersioningCommand

public IfsHandlePublicObjectVersioningCommand()

Default Constructor

(Published)

Method Detail

populateNestedCommands

public void populateNestedCommands(CommandInvoker invoker)
                            throws IfsException

Populate the required nested commands. In this command, we need IfsCheckedOutByCommand, IfsCheckInCommand, IfsCheckOutCommand.

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

Execute a HandlePublicObjectVersioningContext.

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)

runCheckInCommand

protected void runCheckInCommand(LibrarySession session,
                                 PublicObject newVersionObject,
                                 VersionSeries vs,
                                 String comment)
                          throws IfsException

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

Throws:

IfsException

See Also:

IfsCheckInCommand

(Unpublished)

getCheckInCommand

protected IfsCheckInCommand getCheckInCommand()
                                       throws IfsException

Return an instance of the IfsCheckInCommand.

Returns:

IfsCheckInCommand.

Throws:

IfsException

(Unpublished)

runCheckOutCommand

protected void runCheckOutCommand(LibrarySession session,
                                  VersionSeries vs)
                           throws IfsException

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

Throws:

IfsException

See Also:

IfsCheckOutCommand

(Unpublished)

getCheckOutCommand

protected IfsCheckOutCommand getCheckOutCommand()
                                         throws IfsException

Return an instance of the IfsCheckOutCommand.

Returns:

IfsCheckOutCommand.

Throws:

IfsException

(Unpublished)