com.plumtree.server
Interface IPTTempfile

All Superinterfaces:

IPTUnknown

public interface IPTTempfile
extends IPTUnknown

Version:

$Revision$

Author:

Mike Sample

Method Summary

void	Create() Allocates a zero sized temp file in the machine's PLUMTREE_TEMP directory
void	Delete(boolean bIgnoreDeleteErrors) Deletes the file and uninitializes this object.
boolean	GetDeleteWhenDone() Returns an indication of whether the file will be removed when this object is destroyed.
java.lang.String	GetFileExtension() Returns the file extension of the temp file.
java.lang.String	GetFileName() Returns the temp file's name
int	GetFileSize() Returns the current size of the created file
java.lang.String	GetFullPath() Returns the full path to the tempfile.
java.lang.String	GetTempDirectory() Returns the location where temp files get created
void	SetDeleteWhenDone(boolean Value) Sets behavior determining whether the file will be removed when this object is destroyed.
void	SetFileExtension(java.lang.String Value) Sets the file extension of the temp file.
void	SetFileName(java.lang.String Value) Sets the temp file's name
void	SetTempDirectory(java.lang.String Value) Sets the location where temp files will get created

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

Create

void Create()

Allocates a zero sized temp file in the machine's PLUMTREE_TEMP directory

Delete

void Delete(boolean bIgnoreDeleteErrors)

Deletes the file and uninitializes this object.

Parameters:

bIgnoreDeleteErrors - a boolean, if true, completes ignoring I/O errors

GetFullPath

java.lang.String GetFullPath()

Returns the full path to the tempfile. If Create has not yet been called, getting FullPath will automatically call Init().

Returns:

a String containing the fully qualified path of the temp file.

GetFileExtension

java.lang.String GetFileExtension()

Returns the file extension of the temp file.

Returns:

a String containing the file extension.

SetFileExtension

void SetFileExtension(java.lang.String Value)

Sets the file extension of the temp file.

Parameters:

Value - a String containing the file extension.

GetFileName

java.lang.String GetFileName()

Returns the temp file's name

Returns:

a String containg the temp file name

SetFileName

void SetFileName(java.lang.String Value)

Sets the temp file's name

Parameters:

Value - a String containing the proposed temp file name

GetTempDirectory

java.lang.String GetTempDirectory()

Returns the location where temp files get created

Returns:

a String containing the path to the temp file directory

SetTempDirectory

void SetTempDirectory(java.lang.String Value)

Sets the location where temp files will get created

Parameters:

Value - a String containing the path to the temp file directory

GetDeleteWhenDone

boolean GetDeleteWhenDone()

Returns an indication of whether the file will be removed when this object is destroyed.

Returns:

a boolean, if true, indicates file removal when object is destroyed

SetDeleteWhenDone

void SetDeleteWhenDone(boolean Value)

Sets behavior determining whether the file will be removed when this object is destroyed.

Parameters:

Value - a boolean, if true, indicates file removal when object is destroyed

GetFileSize

int GetFileSize()

Returns the current size of the created file

Returns:

The size of the current file in bytes.