oracle.ifs.protocols.commands

Class IfsIsCheckedOutContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsIsCheckedOutContext

All Implemented Interfaces:

IsCheckedOutContext, CommandContext

public class IfsIsCheckedOutContext
extends IfsCommandContext
implements IsCheckedOutContext

IfsIsCheckedOutContext is the default implmentation of IsCheckedOutContext.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsIsCheckedOutContext() Deafult Constructor.
IfsIsCheckedOutContext(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.
boolean	getResults() Gets the results.
VersionSeries	getVersionSeries() Gets the version series.
void	setLibrarySession(LibrarySession session) Sets the session.
void	setResults(boolean isCheckedOut) Sets the results.
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

IfsIsCheckedOutContext

public IfsIsCheckedOutContext()
                       throws IfsException

Deafult Constructor.

Throws:

IfsException

(Published)

IfsIsCheckedOutContext

public IfsIsCheckedOutContext(LibrarySession session,
                              VersionSeries vs)
                       throws IfsException

Constructor to set up all required parameters.

Parameters:

session - LibrarySession.

vs - VersionSeries within which the document belongs to.

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 IsCheckedOutContext

Throws:

IfsException

(Published)

setLibrarySession

public void setLibrarySession(LibrarySession session)
                       throws IfsException

Sets the session.

Specified by:

setLibrarySession in interface IsCheckedOutContext

Throws:

IfsException

(Published)

getVersionSeries

public VersionSeries getVersionSeries()
                               throws IfsException

Gets the version series.

Specified by:

getVersionSeries in interface IsCheckedOutContext

Throws:

IfsException

(Published)

setVersionSeries

public void setVersionSeries(VersionSeries vs)
                      throws IfsException

Sets the version series.

Specified by:

setVersionSeries in interface IsCheckedOutContext

Throws:

IfsException

(Published)

getResults

public boolean getResults()
                   throws IfsException

Gets the results.

Specified by:

getResults in interface IsCheckedOutContext

Throws:

IfsException

(Published)

setResults

public void setResults(boolean isCheckedOut)
                throws IfsException

Sets the results.

Specified by:

setResults in interface IsCheckedOutContext

Throws:

IfsException

(Published)