Bookshelf Home | Contents | Index | Search | PDF

Siebel Developer's Reference > Business Component Classes > CSSBCFile Class >

CSSBCFile Methods

---

This section describes the methods that are implemented in the CSSBCFile Class.

CopyPlain

The CopyPlain method creates a copy of a file in the Siebel File System. Proposal Generator requires this method.

Argument	Description
src	The source file.
dest	The destination file.
bKeepSrcTimeStamp	Boolean indicator of whether or not to keep the timestamp from the source file.
bSetReadOnly	Boolean indicator of whether or not to set the new file to read-only.
bSrcInternal	Boolean indicator of whether or not the source file is internal.
bDestInternal	Boolean indicator of whether or not the destination file is internal.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke CopyPlain from server script and business services. You can also invoke this method through custom buttons and commands.

CreateFile

The CreateFile method creates a file in the Siebel File System from an external source.

Argument	Description
srcFilePath	The path to the source file.
keyFileName	The name of the file.
bKeepLink	Boolean indicator of whether or not to keep a link to the external file.
altSrcFileName	An alternative filename.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke CreateFile from server script and business services. You can also invoke this method through custom buttons and commands.

CreateFileFromPtr

The CreateFileFromPtr method creates a file in the Siebel File System from an external source.

Argument	Description
pFile
keyFileName	The name of the file.
fileName	The external name of the file.
bKeepLink	Boolean indicator of whether or not to keep a link to the external file.
bNoFile = FALSE

Origin	Implemented in CSSBCFile.
Invocable	You can invoke CreateFileFromPtr from server script and business services. You can also invoke this method through custom buttons and commands.

CreateTempFile

The CreateTempFile method creates a file in the user's temp directory from an external source.

Argument	Description
srcFilePath	The path to the source file.
keyFileName	The name of the file.
bKeepLink	Boolean indicator of whether or not to keep a link to the external file.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke CreateTempFile from server script and business services. You can also invoke this method through custom buttons and commands.

DeleteFile

The DeleteFile method deletes a file. Proposal Generator requires this method.

Argument	Description
filename	The name of the file to delete.
bInternal	Boolean indicator of whether or not the file is internal.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke DeleteFile from server script and business services. You can also invoke this method through custom buttons and commands.

DeleteFileLink

The DeleteFileLink method deletes the link between a file in the Siebel File System and an external source.

Argument	Description
keyFieldName	The field that contains the link to be deleted.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke DeleteFileLink from server script and business services. You can also invoke this method through custom buttons and commands.

DoesSiebelFileExist

The DoesSiebelFileExist method verifies whether or not a file exists in the Siebel File System.

Argument	Description
keyFieldName	The internal file name.
bExists	A Boolean indicator of whether or not it exists.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke DoesSiebelFileExist from server script and business services. You can also invoke this method through custom buttons and commands.

DoesTempFileExist

The DoesTempFileExist method verifies whether or not the temporary file exists on the Siebel Server.

Argument	Description
keyFieldName	The internal file name.
bExists	A Boolean indicator of whether or not it exists.
fileName	The external filename.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke DoesTempFileExist from server script and business services. You can also invoke this method through custom buttons and commands.

GetFile

The GetFile method copies a file from the Siebel File System into a specific directory.

Argument	Description
outFilePath	The destination path.
keyFieldName	The file to copy.
returnVal	The return value.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke GetFile from server script and business services. You can also invoke this method through custom buttons and commands.

GetFileDirect

The GetFileDirect method copies a file from the Siebel File System into the user's temp directory. Proposal Generator requires this method.

Argument	Description
outFilePath	The destination path.
externalFileName	The name of the destination file.
idValue	The User Id of the current user.
tableName	The name of the table.
fileExtension	The extension of the file.
fileType	The type of file.
fileRev	The revision number of the file.
returnVal	The return value.
bUnqFileName	Boolean indicator of whether or not the filename must be unique.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke GetFileDirect from server script and business services. You can also invoke this method through custom buttons and commands.

GetFileName

The GetFileName method creates a record for a new file in the business component and returns the internal filename that can be used.

Argument	Description
fileName	The name of the file.
extFileName	The external filename.
keyFieldName	The key field name.
returnVal	The return value.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke GetFileName from server script and business services. You can also invoke this method through custom buttons and commands.

GetFileToDir

The GetFileToDir method copies a file from the Siebel File System into a specific directory.

Argument	Description
pOutFileDir	A pointer to the output file directory.
keyFieldName	The key field name.
outFilePath	The destination path.
returnVal	The return value.
bUnqFileName	Boolean indicator of whether or not the filename must be unique.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke GetFileToDir from server script and business services. You can also invoke this method through custom buttons and commands.

GetFSMFileName

The GetFSMFileName method returns the internal filename.

Argument	Description
fileName	The name of the file.
keyFieldName	The key field name.
returnVal	The return value.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke GetFSMFileName from server script and business services. You can also invoke this method through custom buttons and commands.

GetFSMFileNameFast

Similar to GetFSMFileName, the GetFSMFileNameFast method returns the internal filename, but does not verify the existence of the file in the file system.

Argument	Description
fileName	The name of the file.
keyFieldName	The key field name.
returnVal	The return value.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke GetFSMFileNameFast from server script and business services. You can also invoke this method through custom buttons and commands.

GetSiebelFile

The GetSiebelFile method gets the name of a file in the Siebel internal format.

Argument	Description
outFilePath	The path to the file.
keyFieldName	The key field name.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke GetSiebelFile from server script and business services. You can also invoke this method through custom buttons and commands.

GetUserDirectory

The GetUserDirectory method gets the user directory.

Argument	Description
userDirectory	The user directory.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke GetUserDirectory from server script and business services. You can also invoke this method through custom buttons and commands.

PutFile

The PutFile method updates a file in the Siebel File System from the user's temp directory.

Argument	Description
fileName	The name of the file.
keyFieldName	The key field name.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke PutFile from server script and business services. You can also invoke this method through custom buttons and commands.

SetFileSizeAndTime

The SetFileSizeAndTime method sets the FileSize and ModificationTime fields of a file recently created in the pending business component record.

Argument	Description
keyFieldName	The key field name.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke SetFileSizeAndTime from server script and business services. You can also invoke this method through custom buttons and commands.

UpdateSrcFromLink

The UpdateSrcFromLink method updates a file in the Siebel File System from its external link.

Argument	Description
keyFieldName	The key field name.

Origin	Implemented in CSSBCFile.
Invocable	You can invoke UpdateSrcFromLink from server script and business services. You can also invoke this method through custom buttons and commands.

Bookshelf Home | Contents | Index | Search | PDF