gov.nih.nlm.nls.vtt.Model
Class SaveInfo

java.lang.Object
  gov.nih.nlm.nls.vtt.Model.SaveInfo

public class SaveInfo
extends java.lang.Object

This is the Save Information Java object class. It includes VTT file format version, user name, and time stamp.

History:

• SCR-98, chlu, 02-02-10, add who/when/file format to VTT file.

Version:

V-2010

Author:

NLM NLS Development Team, clu

Constructor Summary

SaveInfo()
Create a SaveInfo Java object with default values.

SaveInfo(SaveInfo saveInfo)
Create a SaveInfo Java object by specifying a tag.

SaveInfo(java.lang.String vttFileVersion, java.lang.String userName, java.lang.String dateTime)
Create a SaveInfo Java object by specifying vtt file version, user name, and data time stamp.

Method Summary

java.lang.String	GetDateTime() Get the Date time stamp
java.lang.String	GetUserName() Get the user name
java.lang.String	GetVttFileVersion() Get the vtt file version
void	SetDateTime(java.lang.String dateTime) Set the date time stamp
void	SetSaveInfo(SaveInfo saveInfo) Set saveInfo to a specified saveInfo
void	SetUserName(java.lang.String userName) Set the user name
void	SetVttFileVersion(java.lang.String vttFileVersion) Set the VTT file format version
java.lang.String	ToString() Convert SaveInfo to a string representation: SAVE_HISTORY|vtt file version|user name|time stamp
static java.lang.String	ToString(SaveInfo saveInfo) Convert a specified SaveInfo to a string representation: SAVE_HISTORY|vtt file version|user name|time stamp

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveInfo

public SaveInfo()

Create a SaveInfo Java object with default values.

SaveInfo

public SaveInfo(SaveInfo saveInfo)

Create a SaveInfo Java object by specifying a tag.

Parameters:

saveInfo - a saveInfo to be instantiated

SaveInfo

public SaveInfo(java.lang.String vttFileVersion,
                java.lang.String userName,
                java.lang.String dateTime)

Create a SaveInfo Java object by specifying vtt file version, user name, and data time stamp.

Parameters:

vttFileVersion - VTT file format version

userName - user name

dateTime - date time stamp

Method Detail

SetVttFileVersion

public void SetVttFileVersion(java.lang.String vttFileVersion)

Set the VTT file format version

Parameters:

vttFileVersion - VTT file format version

SetUserName

public void SetUserName(java.lang.String userName)

Set the user name

Parameters:

userName - user name

SetDateTime

public void SetDateTime(java.lang.String dateTime)

Set the date time stamp

Parameters:

dateTime - date time stamp

GetVttFileVersion

public java.lang.String GetVttFileVersion()

Get the vtt file version

Returns:

the background color of text

GetUserName

public java.lang.String GetUserName()

Get the user name

Returns:

the user name

GetDateTime

public java.lang.String GetDateTime()

Get the Date time stamp

Returns:

the date time stamp

SetSaveInfo

public void SetSaveInfo(SaveInfo saveInfo)

Set saveInfo to a specified saveInfo

Parameters:

saveInfo - the specified saveInfo

ToString

public java.lang.String ToString()

Convert SaveInfo to a string representation: SAVE_HISTORY|vtt file version|user name|time stamp

Returns:

string representation of a SaveInfo

ToString

public static java.lang.String ToString(SaveInfo saveInfo)

Convert a specified SaveInfo to a string representation: SAVE_HISTORY|vtt file version|user name|time stamp

Returns:

string representation of a specified Save Info