oracle.ifs.protocols.commands

Class IfsIsCheckedOutCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsIsCheckedOutCommand

All Implemented Interfaces:

Command

public class IfsIsCheckedOutCommand
extends IfsCommand

A IfsIsCheckedOutCommand returns a boolean value indicating whether the document is currently being checked out by an user or not. Return 'true' if it is checked out, 'false' otherwise.

Command specification for IfsIsCheckedOutCommand

Inputs:

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

Outputs :

• results : boolean

Description:

• Checks to see if vs is currently reserved or not.
• Return 'true' if it is, 'false' if not.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsIsCheckedOutCommand() 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(IsCheckedOutContext context) Execute a IsCheckedOutContext.

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

IfsIsCheckedOutCommand

public IfsIsCheckedOutCommand()

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

Execute a IsCheckedOutContext.

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)