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.
|
|
|
|
|
|
|
Boolean indicator of whether or not to keep the timestamp from the source file. |
|
Boolean indicator of whether or not to set the new file to read-only. |
|
Boolean indicator of whether or not the source file is internal. |
|
Boolean indicator of whether or not the destination file is internal. |
|
Implemented in CSSBCFile. |
|
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.
|
|
|
The path to the source file. |
|
|
|
Boolean indicator of whether or not to keep a link to the external file. |
|
|
|
Implemented in CSSBCFile. |
|
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.
|
|
|
|
|
|
|
The external name of the file. |
|
Boolean indicator of whether or not to keep a link to the external file. |
|
|
|
Implemented in CSSBCFile. |
|
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.
|
|
|
The path to the source file. |
|
|
|
Boolean indicator of whether or not to keep a link to the external file. |
|
Implemented in CSSBCFile. |
|
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.
|
|
|
The name of the file to delete. |
|
Boolean indicator of whether or not the file is internal. |
|
Implemented in CSSBCFile. |
|
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.
|
|
|
The field that contains the link to be deleted. |
|
Implemented in CSSBCFile. |
|
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.
|
|
|
|
|
A Boolean indicator of whether or not it exists. |
|
Implemented in CSSBCFile. |
|
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.
|
|
|
|
|
A Boolean indicator of whether or not it exists. |
|
|
|
Implemented in CSSBCFile. |
|
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.
|
Implemented in CSSBCFile. |
|
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.
|
|
|
|
|
The name of the destination file. |
|
The User Id of the current user. |
|
|
|
The extension of the file. |
|
|
|
The revision number of the file. |
|
|
|
Boolean indicator of whether or not the filename must be unique. |
|
Implemented in CSSBCFile. |
|
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.
|
Implemented in CSSBCFile. |
|
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.
|
|
|
A pointer to the output file directory. |
|
|
|
|
|
|
|
Boolean indicator of whether or not the filename must be unique. |
|
Implemented in CSSBCFile. |
|
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.
|
Implemented in CSSBCFile. |
|
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.
|
Implemented in CSSBCFile. |
|
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.
|
Implemented in CSSBCFile. |
|
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.
|
Implemented in CSSBCFile. |
|
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.
|
Implemented in CSSBCFile. |
|
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.
|
Implemented in CSSBCFile. |
|
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.
|
Implemented in CSSBCFile. |
|
You can invoke UpdateSrcFromLink from server script and business services. You can also invoke this method through custom buttons and commands. |