com.altair.hwm.fileserver.client
Interface IHWMFileServerClient

All Known Implementing Classes:

HWMFileServerClientSOAP, HWMFSComm

public interface IHWMFileServerClient

Title: IHWMFileServerClient

Description: This is the interface that the file server client implementgation will have to implement.

Company: Altair Engineering, Inc.

Method Summary

HWMFileInfo	AddFile(java.io.File file, java.lang.String strFName, java.lang.String strFType, java.lang.String strRevision, java.lang.String strUser, java.lang.String strFDesc, java.lang.String strVerDesc, boolean bCompress) Adds the file into the database
HWMFileInfo	CheckIn(java.io.File file, int nFileID, java.lang.String strRevision, java.lang.String strUser, java.lang.String strVerDesc, boolean bCompress) The given revision of the file with given id is checked in under a new version under the given revision.
HWMFileInfo	CheckOut(int nFileID, java.lang.String strUser, boolean bUnCompress) 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, boolean bUnCompress) 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, boolean bUnCompress) Check out the latest version under the given revision of the file with given id
HWMFileInfo	Get(int nFileID, boolean bUnCompress) Get the latest version under the latest revision of the file with given id
HWMFileInfo	Get(int nFileID, java.lang.String strRevision, boolean bUnCompress) Get the latest version under the given revision of the file with given id
HWMFileInfo	Get(int nFileID, java.lang.String strRevision, int nVersion, boolean bUnCompress) Get the given version under the given revision of the file with given id
HWMFileInfo	GetFileInfo(int nFileID) Get the file info of latest version under the latest revision of the file with given id
HWMFileInfo	GetFileInfo(int nFileID, java.lang.String strRevision) Get the file info of latest version under the given revision of the file with given id
HWMFileInfo	GetFileInfo(int nFileID, java.lang.String strRevision, int nVersion) Get the file info of given version under the given revision of the file with given id
void	Purge(int nFileID) Remove all the files associated with the given file id
void	Purge(int nFileID, java.lang.String strRevision) Remove the given revision and versions under the revision of file associated with the given file id
void	Purge(int nFileID, java.lang.String strRevision, int nVersion) Remove the version under the given revision of file associated with the given file id
java.util.Vector	Query(java.lang.String strFName, int nFileID, java.lang.String strFType, java.lang.String strFDesc, java.lang.String strRevision, int nVersion, java.lang.String strUser, java.lang.String verDesc, boolean bAnd) Query for file information.
HWMFileInfo	Revise(int nFileID, java.lang.String strRevision, int nVersion, java.lang.String strNewRevision, java.lang.String strVerDesc, java.lang.String strUser) Create a new revision for the file with given attributes.
HWMFileInfo	Revise(int nFileID, java.lang.String strRevision, java.lang.String strNewRevision, java.lang.String strVerDesc, java.lang.String strUser) Create a new revision for the file with given attributes.
void	UndoCheckOut(int nFileID, java.lang.String strUser) The check out status on the latest revision of the file with given id is set back to checked in if it was checked out by the same user.
void	UndoCheckOut(int nFileID, java.lang.String strRevision, java.lang.String strUser) The check out status on the revision of the file with given id is set back to checked in if it was checked out by the same user.

Method Detail

AddFile

HWMFileInfo AddFile(java.io.File file,
                    java.lang.String strFName,
                    java.lang.String strFType,
                    java.lang.String strRevision,
                    java.lang.String strUser,
                    java.lang.String strFDesc,
                    java.lang.String strVerDesc,
                    boolean bCompress)
                    throws java.lang.Exception

Adds the file into the database

Parameters:

file - The file to add

strFName - The file name to add

strFType - The file type

strRevision - The revision name for the new file

strUser - The user who wants to add the file

strFDesc - The description for this new file

strVerDesc - The description for the first version

bCompress - Compress the file or not. if true - compreesion will be done.

Returns:

HWMFileInfo The file information

Throws:

java.lang.Exception

CheckIn

HWMFileInfo CheckIn(java.io.File file,
                    int nFileID,
                    java.lang.String strRevision,
                    java.lang.String strUser,
                    java.lang.String strVerDesc,
                    boolean bCompress)
                    throws java.lang.Exception

The given revision of the file with given id is checked in under a new version under the given revision.

Parameters:

file - The file to check in

nFID - The file id to check in

strRevision - The revision name for the new file

strUser - The user who wants to add the file

strVerDesc - The description for the first version

bCompress - Compress the file or not. if true - compreesion will be done.

Returns:

HWMFileInfo The file information

Throws:

java.lang.Exception

CheckOut

HWMFileInfo CheckOut(int nFileID,
                     java.lang.String strUser,
                     boolean bUnCompress)
                     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

bUnCompress - Uncompress the file or not. if true - uncompression will be done.

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

CheckOut

HWMFileInfo CheckOut(int nFileID,
                     java.lang.String strRevision,
                     java.lang.String strUser,
                     boolean bUnCompress)
                     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

bUnCompress - Uncompress the file or not. if true - uncompression will be done.

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

CheckOut

HWMFileInfo CheckOut(int nFileID,
                     java.lang.String strRevision,
                     int nVersion,
                     java.lang.String strUser,
                     boolean bUnCompress)
                     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

bUnCompress - Uncompress the file or not. if true - uncompression will be done.

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

Get

HWMFileInfo Get(int nFileID,
                boolean bUnCompress)
                throws java.lang.Exception

Get the latest version under the latest revision of the file with given id

Parameters:

nFileID - The file id of the file to return

bUnCompress - Uncompress the file or not. if true - uncompression will be done.

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

Get

HWMFileInfo Get(int nFileID,
                java.lang.String strRevision,
                boolean bUnCompress)
                throws java.lang.Exception

Get the latest version under the given revision of the file with given id

Parameters:

nFileID - The file id of the file to return

strRevision - The revision of the file to return

bUnCompress - Uncompress the file or not. if true - uncompression will be done.

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

Get

HWMFileInfo Get(int nFileID,
                java.lang.String strRevision,
                int nVersion,
                boolean bUnCompress)
                throws java.lang.Exception

Get the given version under the given revision of the file with given id

Parameters:

nFileID - The file id of the file to return

strRevision - The revision of the file to return

nVersion - the version to return.

bUnCompress - Uncompress the file or not. if true - uncompression will be done.

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

GetFileInfo

HWMFileInfo GetFileInfo(int nFileID)
                        throws java.lang.Exception

Get the file info of latest version under the latest revision of the file with given id

Parameters:

nFileID - The file id of the file info to return

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

GetFileInfo

HWMFileInfo GetFileInfo(int nFileID,
                        java.lang.String strRevision)
                        throws java.lang.Exception

Get the file info of latest version under the given revision of the file with given id

Parameters:

nFileID - The file id of the file info to return

strRevision - The revision of the file info to return

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

GetFileInfo

HWMFileInfo GetFileInfo(int nFileID,
                        java.lang.String strRevision,
                        int nVersion)
                        throws java.lang.Exception

Get the file info of given version under the given revision of the file with given id

Parameters:

nFileID - The file id of the file info to return

strRevision - The revision of the file info to return

nVersion - the version to return.

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

Purge

void Purge(int nFileID)
           throws java.lang.Exception

Remove all the files associated with the given file id

Parameters:

nFileID - The file id to remove

Throws:

java.lang.Exception

Purge

void Purge(int nFileID,
           java.lang.String strRevision)
           throws java.lang.Exception

Remove the given revision and versions under the revision of file associated with the given file id

Parameters:

nFileID - The file id to remove

strRevision - The revision to remove

Throws:

java.lang.Exception

Purge

void Purge(int nFileID,
           java.lang.String strRevision,
           int nVersion)
           throws java.lang.Exception

Remove the version under the given revision of file associated with the given file id

Parameters:

nFileID - The file id to remove

strRevision - The revision to remove

nVersion - The version to remove

Throws:

java.lang.Exception

Query

java.util.Vector Query(java.lang.String strFName,
                       int nFileID,
                       java.lang.String strFType,
                       java.lang.String strFDesc,
                       java.lang.String strRevision,
                       int nVersion,
                       java.lang.String strUser,
                       java.lang.String verDesc,
                       boolean bAnd)
                       throws java.lang.Exception

Query for file information.

Parameters:

strFName - The file name

nFileID - The file id If -1 - ignored

strFType - The file type

strFDesc - The file decsription

strRevision - The revision name

nVersion - The version for the file. If -1 - ignored

strser - The user name

strVerDesc - the version description

bAnd - If true - the conjunction of all the conditions is considered else disjunction

Returns:

Vector vector of HWMFileInfo containing file information for each of the matched result

Throws:

java.lang.Exception

Revise

HWMFileInfo Revise(int nFileID,
                   java.lang.String strRevision,
                   java.lang.String strNewRevision,
                   java.lang.String strVerDesc,
                   java.lang.String strUser)
                   throws java.lang.Exception

Create a new revision for the file with given attributes.

Parameters:

nFileID - The ID of the file to revise

strRevision - The revision name of the file to revise

strNewRevision - The new revision name

strVerDesc - The version description to use for the first version of the new file.

strUser - The user name whois creating a new revision

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

Revise

HWMFileInfo Revise(int nFileID,
                   java.lang.String strRevision,
                   int nVersion,
                   java.lang.String strNewRevision,
                   java.lang.String strVerDesc,
                   java.lang.String strUser)
                   throws java.lang.Exception

Create a new revision for the file with given attributes.

Parameters:

nFileID - The ID of the file to revise

strRevision - The revision name of the file to revise

nVersion - The version of the file to revise

strNewRevision - The new revision name

strVerDesc - The version description to use for the first version of the new file.

strUser - The user name whois creating a new revision

Returns:

HWMFileInfo The file info object

Throws:

java.lang.Exception

UndoCheckOut

void UndoCheckOut(int nFileID,
                  java.lang.String strRevision,
                  java.lang.String strUser)
                  throws java.lang.Exception

The check out status on the revision of the file with given id is set back to checked in if it was checked out by the same user.

Parameters:

nFileID - The file id of the file to undo check out

strRevision - The revision to undo check out on

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

Throws:

java.lang.Exception

UndoCheckOut

void UndoCheckOut(int nFileID,
                  java.lang.String strUser)
                  throws java.lang.Exception

The check out status on the latest revision of the file with given id is set back to checked in if it was checked out by the same user.

Parameters:

nFileID - The file id of the file to undo check out

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

Throws:

java.lang.Exception