com.altair.hwm.fileserver
Class HWMFileInfo

java.lang.Object
  com.altair.hwm.fileserver.HWMFileInfo

public class HWMFileInfo
extends java.lang.Object

Title: HWMFileInfo

Description: This class contains the information for a file

Company: Altair Engineering, Inc.

Constructor Summary

HWMFileInfo()
Constructor

Method Summary

short	GetCheckedOut() Get the short indicating if the file is checked out.
java.lang.String	GetDate() Get the date
java.lang.String	GetFDesc() Get the file description
java.io.File	GetFile() Get the file to transfer
int	GetFileID() Get the file id
java.lang.String	GetFileName() Get the file name
java.lang.String	GetFileType() Get the file type
java.io.InputStream	GetInputStream() Get the byte array input stream for the file
java.lang.String	GetRevision() Get the revision name
java.lang.String	GetTime() Get the time
java.lang.String	GetUser() Get the user name
java.lang.String	GetVerDesc() Get the version description
int	GetVersion() Get the file version
boolean	HasRevisions() Get the flag indicating if the file has more revisions
boolean	HasVersions() Get the flag indicating if the file has more versions under this revision
boolean	IsCheckedOut() Get the flag indicating if the file has been checked out.
void	SetCheckedOut(boolean bCheckedOut) Set the flag indicating if the file is checked out.
void	SetCheckedOut(short nCheckedOut) Set the short indicating if the file is checked out.
void	SetDate(java.lang.String strDate) Set the date
void	SetFDesc(java.lang.String strFDesc) Set the file description
void	SetFile(java.io.File file) Set the file to transfer
void	SetFileID(int nFileID) Set the file id
void	SetFileName(java.lang.String strFName) Set the file name
void	SetFileType(java.lang.String strFType) Set the file type
void	SetHasRevisions(boolean bHasRevisions) Set the flag indicating if the file has more revisions
void	SetHasVersions(boolean bHasVersions) Set the flag indicating if the file has more versions under this revision
void	SetInputStream(java.io.InputStream is) Set the input stream for the file
void	SetRevision(java.lang.String strRev) Set the revision name
void	SetTime(java.lang.String strTime) Set the time
void	SetUser(java.lang.String strUser) Set the user name
void	SetVerDesc(java.lang.String strVerDesc) Set the version description
void	SetVersion(int nVer) Set the file version

Methods inherited from class java.lang.Object

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

Constructor Detail

HWMFileInfo

public HWMFileInfo()

Constructor

Method Detail

SetFileName

public void SetFileName(java.lang.String strFName)

Set the file name

Parameters:

strFName - The file name

GetFileName

public java.lang.String GetFileName()

Get the file name

Returns:

String The file name

SetFileType

public void SetFileType(java.lang.String strFType)

Set the file type

Parameters:

strFType - The file type

GetFileType

public java.lang.String GetFileType()

Get the file type

Returns:

String The file type

SetFileID

public void SetFileID(int nFileID)

Set the file id

Parameters:

nFileID - The file id

GetFileID

public int GetFileID()

Get the file id

Returns:

int The file id

SetUser

public void SetUser(java.lang.String strUser)

Set the user name

Parameters:

strUser - The user name

GetUser

public java.lang.String GetUser()

Get the user name

Returns:

String The user name

SetFDesc

public void SetFDesc(java.lang.String strFDesc)

Set the file description

Parameters:

strFDesc - The file description

GetFDesc

public java.lang.String GetFDesc()

Get the file description

Returns:

String The file description

SetVerDesc

public void SetVerDesc(java.lang.String strVerDesc)

Set the version description

Parameters:

strVerDesc - The version description

GetVerDesc

public java.lang.String GetVerDesc()

Get the version description

Returns:

String The version description

SetRevision

public void SetRevision(java.lang.String strRev)

Set the revision name

Parameters:

strRev - The revision name

GetRevision

public java.lang.String GetRevision()

Get the revision name

Returns:

String The revision name

SetVersion

public void SetVersion(int nVer)

Set the file version

Parameters:

nVer - The file version

GetVersion

public int GetVersion()

Get the file version

Returns:

int The file version

SetDate

public void SetDate(java.lang.String strDate)

Set the date

Parameters:

strDate - The date this file was added/created in the file server

GetDate

public java.lang.String GetDate()

Get the date

Returns:

String The date this file was added/created in the file server

SetTime

public void SetTime(java.lang.String strTime)

Set the time

Parameters:

strTime - The time this file was added/created in the file server

GetTime

public java.lang.String GetTime()

Get the time

Returns:

String The time this file was added/created in the file server

SetHasRevisions

public void SetHasRevisions(boolean bHasRevisions)

Set the flag indicating if the file has more revisions

Parameters:

bHasRevisions - true if the file has more recent revisions else false

HasRevisions

public boolean HasRevisions()

Get the flag indicating if the file has more revisions

Returns:

boolean true if the file has more recent revisions else false

SetHasVersions

public void SetHasVersions(boolean bHasVersions)

Set the flag indicating if the file has more versions under this revision

Parameters:

bHasVersions - true if the file has more recent versions under this revision

HasVersions

public boolean HasVersions()

Get the flag indicating if the file has more versions under this revision

Returns:

boolean true if the file has more recent versions under this revision

SetCheckedOut

public void SetCheckedOut(short nCheckedOut)

Set the short indicating if the file is checked out. If checked out - HWMFileServerConstants.CONST_COUT else HWMFileServerConstants.CONST_COUT

Parameters:

nCheckedOut - If checked out - HWMFileServerConstants.CONST_COUT else HWMFileServerConstants.CONST_COUT

SetCheckedOut

public void SetCheckedOut(boolean bCheckedOut)

Set the flag indicating if the file is checked out.

Parameters:

bCheckedOut - If true then checked out else false

GetCheckedOut

public short GetCheckedOut()

Get the short indicating if the file is checked out. If checked out - HWMFileServerConstants.CONST_COUT else HWMFileServerConstants.CONST_COUT

Returns:

short If checked out - HWMFileServerConstants.CONST_COUT else HWMFileServerConstants.CONST_COUT

IsCheckedOut

public boolean IsCheckedOut()

Get the flag indicating if the file has been checked out. If checked out - true else false

Returns:

boolean If checked out - true else false

SetInputStream

public void SetInputStream(java.io.InputStream is)

Set the input stream for the file

Parameters:

is - The input stream

GetInputStream

public java.io.InputStream GetInputStream()

Get the byte array input stream for the file

Returns:

ByteArrayInputStream The byte array input stream

SetFile

public void SetFile(java.io.File file)

Set the file to transfer

Parameters:

file - The file to transfer

GetFile

public java.io.File GetFile()

Get the file to transfer

Returns:

File The file to transfer