com.altair.hwm.fileserver.server
Class HWMCheckOut

java.lang.Object
  com.altair.hwm.fileserver.server.HWMCheckOut

public class HWMCheckOut
extends java.lang.Object

Title: HWMCheckOut

Description: Check out the given file. A file can be checked out using:

a> user name, file id only: The latest version under the latest revision of the file with given id is checked out

b> user name, file id and revision only: The latest version under the given revision of the file with given id is checked out

c> user name, file id, revision and version: The given version under the given revision of the file with given id is checked out

Company: Altair Engineering, Inc.

Constructor Summary

HWMCheckOut(HWMFileServer hwmFS)
Constructor

Method Summary

HWMFileInfo	CheckOut(int nFileID, java.lang.String strUser) Check out the latest version under the latest revision of the file with given id
HWMFileInfo	CheckOut(int nFileID, java.lang.String strRevision, int nVersion, java.lang.String strUser) Check out the given version under the given revision of the file with given id
HWMFileInfo	CheckOut(int nFileID, java.lang.String strRevision, java.lang.String strUser) Check out the latest version under the given revision of the file with given id

Methods inherited from class java.lang.Object

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

Constructor Detail

HWMCheckOut

public HWMCheckOut(HWMFileServer hwmFS)

Constructor

Parameters:

hwmFS - The file server object that initailizes the file server and contains the db cxn pool

Method Detail

CheckOut

public HWMFileInfo CheckOut(int nFileID,
                            java.lang.String strUser)
                     throws java.lang.Exception

Check out the latest version under the latest revision of the file with given id

Parameters:

nFileID - The file id of the file to check out

strUser - The name of the user who wants to check out the file

Returns:

HWMFileServer The file server object

Throws:

java.lang.Exception

CheckOut

public HWMFileInfo CheckOut(int nFileID,
                            java.lang.String strRevision,
                            java.lang.String strUser)
                     throws java.lang.Exception

Check out the latest version under the given revision of the file with given id

Parameters:

nFileID - The file id of the file to check out

strRevision - The revision of the file to check out

strUser - The name of the user who wants to check out the file

Returns:

HWMFileServer The file server object

Throws:

java.lang.Exception

CheckOut

public HWMFileInfo CheckOut(int nFileID,
                            java.lang.String strRevision,
                            int nVersion,
                            java.lang.String strUser)
                     throws java.lang.Exception

Check out the given version under the given revision of the file with given id

Parameters:

nFileID - The file id of the file to check out

strRevision - The revision of the file to check out

nVersion - the version to check out.

strUser - The name of the user who wants to check out the file

Returns:

HWMFileServer The file server object

Throws:

java.lang.Exception