oracle.ifs.protocols.commands

Class IfsCheckedOutByContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsCheckedOutByContext

All Implemented Interfaces:

CheckedOutByContext, CommandContext

public class IfsCheckedOutByContext
extends IfsCommandContext
implements CheckedOutByContext

IfsCheckedOutByContext is the default implmentation of CheckedOutByContext.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsCheckedOutByContext() Deafult Constructor.
IfsCheckedOutByContext(LibrarySession session, VersionSeries vs) Constructor to set up all required parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
LibrarySession	getLibrarySession() Gets the session.
DirectoryUser	getReservor() Gets the reservor.
VersionSeries	getVersionSeries() Gets the version series.
void	setLibrarySession(LibrarySession session) Sets the session.
void	setReservor(DirectoryUser user) Sets the reservor.
void	setVersionSeries(VersionSeries vs) Sets the version series.

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsCheckedOutByContext

public IfsCheckedOutByContext()
                       throws IfsException

Deafult Constructor.

Throws:

IfsException

(Published)

IfsCheckedOutByContext

public IfsCheckedOutByContext(LibrarySession session,
                              VersionSeries vs)
                       throws IfsException

Constructor to set up all required parameters.

Parameters:

session - LibrarySession.

vs - VersionSeries within which the document is checked out.

Throws:

IfsException - If operation fails.

(Published)

Method Detail

clear

public void clear()

Clears the Context.

Specified by:

clear in interface CommandContext

Overrides:

clear in class IfsCommandContext

(Published)

getLibrarySession

public LibrarySession getLibrarySession()
                                 throws IfsException

Gets the session.

Specified by:

getLibrarySession in interface CheckedOutByContext

Throws:

IfsException

(Published)

setLibrarySession

public void setLibrarySession(LibrarySession session)
                       throws IfsException

Sets the session.

Specified by:

setLibrarySession in interface CheckedOutByContext

Throws:

IfsException

(Published)

getVersionSeries

public VersionSeries getVersionSeries()
                               throws IfsException

Gets the version series.

Specified by:

getVersionSeries in interface CheckedOutByContext

Throws:

IfsException

(Published)

setVersionSeries

public void setVersionSeries(VersionSeries vs)
                      throws IfsException

Sets the version series.

Specified by:

setVersionSeries in interface CheckedOutByContext

Throws:

IfsException

(Published)

getReservor

public DirectoryUser getReservor()
                          throws IfsException

Gets the reservor.

Specified by:

getReservor in interface CheckedOutByContext

Throws:

IfsException

(Published)

setReservor

public void setReservor(DirectoryUser user)
                 throws IfsException

Sets the reservor.

Specified by:

setReservor in interface CheckedOutByContext

Throws:

IfsException

(Published)