oracle.ifs.protocols.commands

Class IfsCheckInContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsCheckInContext

All Implemented Interfaces:

CheckInContext, CommandContext

public class IfsCheckInContext
extends IfsCommandContext
implements CheckInContext

IfsCheckInContext is the default implmentation of CheckInContext.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
String	getCheckInComment() Gets the check-in comment.
PublicObject	getCheckInObject() Get the potential new version of the object.
LibrarySession	getLibrarySession() Gets the session.
VersionSeries	getVersionSeries() Gets the VersionSeries.
void	setCheckInComment(String comment) Sets the check-in comment.
void	setCheckInObject(PublicObject po) Sets the potential new version of the object.
void	setLibrarySession(LibrarySession session) Sets the session.
void	setVersionSeries(VersionSeries vs) Sets the VersionSeries.

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsCheckInContext

public IfsCheckInContext()
                  throws IfsException

Deafult Constructor.

Throws:

IfsException

(Published)

IfsCheckInContext

public IfsCheckInContext(LibrarySession session,
                         VersionSeries vs,
                         String comment)
                  throws IfsException

Constructor to set up all required parameters.

Parameters:

session - LibrarySession.

vs - VersionSeries in which to check out.

comment - Check-in comment.

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 CheckInContext

Throws:

IfsException

(Published)

setLibrarySession

public void setLibrarySession(LibrarySession session)
                       throws IfsException

Sets the session.

Specified by:

setLibrarySession in interface CheckInContext

Throws:

IfsException

(Published)

getVersionSeries

public VersionSeries getVersionSeries()
                               throws IfsException

Gets the VersionSeries.

Specified by:

getVersionSeries in interface CheckInContext

Throws:

IfsException

(Published)

setVersionSeries

public void setVersionSeries(VersionSeries vs)
                      throws IfsException

Sets the VersionSeries.

Specified by:

setVersionSeries in interface CheckInContext

Throws:

IfsException

(Published)

getCheckInComment

public String getCheckInComment()
                         throws IfsException

Gets the check-in comment.

Specified by:

getCheckInComment in interface CheckInContext

Throws:

IfsException

(Published)

setCheckInComment

public void setCheckInComment(String comment)
                       throws IfsException

Sets the check-in comment.

Specified by:

setCheckInComment in interface CheckInContext

Throws:

IfsException

(Published)

setCheckInObject

public void setCheckInObject(PublicObject po)

Sets the potential new version of the object.

Specified by:

setCheckInObject in interface CheckInContext

(Published)

getCheckInObject

public PublicObject getCheckInObject()

Get the potential new version of the object.

Specified by:

getCheckInObject in interface CheckInContext

(Published)