com.crystaldecisions.sdk.occa.infostore
Interface IFiles

All Superinterfaces:
java.util.Collection, java.util.List

public interface IFiles
extends java.util.List

This interface represents a collection of file objects. These objects support the IFile interface, and are associated with an InfoObject.

This interface defines two categories of operations:

Note: all the file operations are "two-phase". None of the operations will happen until the operations are committed. However, the commit() method will be called implicitly when the associated InfoObject is committed.


Method Summary
 void abort()
           Aborts all changes made to the file repository server.
 ILocalFile addFile(byte[] stream, java.lang.String prefix, java.lang.String ext, java.lang.String destFileName, java.lang.String subDir)
           Adds a stream to the files collection and uploads it to the specified destination on the file repository server with a unique name.
 ILocalFile addFile(java.io.File file)
           The shortcut for addFile(file, false).
 ILocalFile addFile(java.io.File file, boolean deleteLocalFile)
           The shortcut for addFile(file, null,null,null,null,deleteLocalFile).
 ILocalFile addFile(java.io.File file, java.lang.String prefix, java.lang.String ext, java.lang.String destFilename, java.lang.String subDir, boolean deleteLocalFile)
           Adds a local file to the files collection and uploads it to the specified destination on the file repository server.
 ILocalFile addFile(java.lang.String filePath)
           The shortcut for addFile(filePath, false).
 ILocalFile addFile(java.lang.String filePath, boolean deleteLocalFile)
           The shortcut for addFile(filePath, null,null,null,null,null,deleteLocalFile).
 ILocalFile addFile(java.lang.String filePath, java.lang.String prefix, java.lang.String ext, java.lang.String destFilename, java.lang.String subDir, boolean deleteLocalFile)
           Adds a local file to the files collection and uploads it to the specified destination on the file repository server.
 ILocalFile addUniqueFile(byte[] stream)
           This is a shortcut for addUnique(stream, null, null, null).
 ILocalFile addUniqueFile(byte[] stream, java.lang.String prefix, java.lang.String ext, java.lang.String subDir)
           Adds a local stream to the files collection and uploads it to the specified folder under the default folder for this InfoObject on the file repository server using the specified prefix and extension.
 ILocalFile addUniqueFile(java.io.File file)
           This is a shortcut for addUniqueFile(file, false).
 ILocalFile addUniqueFile(java.io.File file, boolean deleteLocalFile)
           This is a shortcut for addUniqueFile(file, null, null, null, deleteLocalFile).
 ILocalFile addUniqueFile(java.io.File file, java.lang.String prefix, java.lang.String ext, java.lang.String subDir, boolean deleteLocalFile)
           Adds a local file to the files collection and uploads it to the specified folder under the default folder for this InfoObject on the file repository server using the specified prefix and extension.
 ILocalFile addUniqueFile(java.lang.String filePath)
           This is a shortcut for addUniqueFile(filePath, false).
 ILocalFile addUniqueFile(java.lang.String filePath, boolean deleteLocalFile)
           This is a shortcut for addUniqueFile(filePath, null, null, null, deleteLocalFile) .
 ILocalFile addUniqueFile(java.lang.String filePath, java.lang.String prefix, java.lang.String ext, java.lang.String subDir, boolean deleteLocalFile)
           Adds a local file to the files collection and uploads it to the specified folder under the default folder for this InfoObject on the file repository server using the specified prefix and extension.
 void commit()
           Commits all changes to the file repository server.
 IFiles copy(java.lang.String destPath)
           Copies this IFiles object to the specified path.
 java.lang.String getFRSPathURL()
           Returns the URL to the File Repository Server path.
 IProperties properties()
           Returns the property bag for this files object.
 IFile replace(int index, byte[] stream, java.lang.String prefix, java.lang.String ext, java.lang.String destFilename, java.lang.String subDir)
           Replaces an existing file in the files collection with a new local file.
 IFile replace(int index, java.io.File file)
           The shortcut for replace(index, file, false).
 IFile replace(int index, java.io.File file, boolean deleteLocalFile)
           The shortcut for replace(index, file, null, null, null, null, deleteLocalFile).
 IFile replace(int index, java.io.File file, java.lang.String prefix, java.lang.String ext, java.lang.String destFilename, java.lang.String subDir, boolean deleteLocalFile)
           Replaces an existing file in the files collection with a new local file.
 IFile replace(int index, java.lang.String filePath)
           The shortcut for replace(index, filePath, false).
 IFile replace(int index, java.lang.String filePath, boolean deleteLocalFile)
           The shortcut for replace(index, filePath, null, null, null, null, deleteLocalFile).
 IFile replace(int index, java.lang.String filePath, java.lang.String prefix, java.lang.String ext, java.lang.String destFilename, java.lang.String subDir, boolean deleteLocalFile)
           Replaces an existing file in the files collection with a new local file.
 IFile replaceUnique(int index, byte[] stream)
           The shortcut for replaceUnique(index, stream, null, null, null).
 IFile replaceUnique(int index, byte[] stream, java.lang.String prefix, java.lang.String ext, java.lang.String subDir)
           Replaces an existing file in the files collection with a new local file.
 IFile replaceUnique(int index, java.io.File file)
           The shortcut for replaceUnique(index, file, false).
 IFile replaceUnique(int index, java.io.File file, boolean deleteLocalFile)
           The shortcut for replaceUnique(index, file, null, null, deleteLocalFile).
 IFile replaceUnique(int index, java.io.File file, java.lang.String prefix, java.lang.String ext, java.lang.String subDir, boolean deleteLocalFile)
           Replaces an existing file in the files collection with a new local file.
 IFile replaceUnique(int index, java.lang.String filePath)
           The shortcut for replaceUnique(index, filePath, false).
 IFile replaceUnique(int index, java.lang.String filePath, boolean deleteLocalFile)
           The shortcut for replaceUnique(index, filePath, null, null, deleteLocalFile).
 IFile replaceUnique(int index, java.lang.String filePath, java.lang.String prefix, java.lang.String ext, java.lang.String subDir, boolean deleteLocalFile)
           Replaces an existing file in the files collection with a new local file.
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray
 

Method Detail

addFile

public ILocalFile addFile(java.lang.String filePath,
                          java.lang.String prefix,
                          java.lang.String ext,
                          java.lang.String destFilename,
                          java.lang.String subDir,
                          boolean deleteLocalFile)
                   throws SDKException

Adds a local file to the files collection and uploads it to the specified destination on the file repository server.

Parameters:
filePath - The local file's path.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, no suffix will be added to the destination file name.
destFilename - The destination file name, excluding the prefix and suffix. That is, if destFileName is not null, the final file name will be <prefix><destFileName>.<ext>. If the destFileName is null, the destination file will have the same name as the local file.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process is unsuccessful.

addFile

public ILocalFile addFile(java.io.File file,
                          java.lang.String prefix,
                          java.lang.String ext,
                          java.lang.String destFilename,
                          java.lang.String subDir,
                          boolean deleteLocalFile)
                   throws SDKException

Adds a local file to the files collection and uploads it to the specified destination on the file repository server.

Parameters:
file - The local file to be added.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, no suffix will be added to the destination file name.
destFilename - The destination file name, excluding the prefix and suffix. The final file name will be <prefix><destFileName>.<ext>.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process is unsuccessful.

addFile

public ILocalFile addFile(byte[] stream,
                          java.lang.String prefix,
                          java.lang.String ext,
                          java.lang.String destFileName,
                          java.lang.String subDir)
                   throws SDKException

Adds a stream to the files collection and uploads it to the specified destination on the file repository server with a unique name.

Parameters:
stream - The byte array to be added.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, no suffix will be added to the destination file name.
destFileName - The destination file name, excluding the prefix and suffix. The final file name will be <prefix><destFileName>.<ext>.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
Returns:
A local file object representing the supplied local stream.
Throws:
SDKException - This is thrown if the process is unsuccessful.

addFile

public ILocalFile addFile(java.lang.String filePath,
                          boolean deleteLocalFile)
                   throws SDKException

The shortcut for addFile(filePath, null,null,null,null,null,deleteLocalFile).

Parameters:
filePath - The local file's path.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept. false if the local file should be kept.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process is unsuccessful.

addFile

public ILocalFile addFile(java.io.File file,
                          boolean deleteLocalFile)
                   throws SDKException

The shortcut for addFile(file, null,null,null,null,deleteLocalFile).

Parameters:
file - The local file to be added.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process is unsuccessful.

addFile

public ILocalFile addFile(java.lang.String filePath)
                   throws SDKException

The shortcut for addFile(filePath, false).

Parameters:
filePath - The local file's path.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process is unsuccessful.

addFile

public ILocalFile addFile(java.io.File file)
                   throws SDKException

The shortcut for addFile(file, false).

Parameters:
file - The local file to be added.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process is unsuccessful.

addUniqueFile

public ILocalFile addUniqueFile(java.lang.String filePath,
                                java.lang.String prefix,
                                java.lang.String ext,
                                java.lang.String subDir,
                                boolean deleteLocalFile)
                         throws SDKException

Adds a local file to the files collection and uploads it to the specified folder under the default folder for this InfoObject on the file repository server using the specified prefix and extension. The file name is randomly chosen by the server, provided it is unique among the files in the same directory.

Parameters:
filePath - The local file's path.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, the local file's extension will be used.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process was unsuccessful.

addUniqueFile

public ILocalFile addUniqueFile(java.io.File file,
                                java.lang.String prefix,
                                java.lang.String ext,
                                java.lang.String subDir,
                                boolean deleteLocalFile)
                         throws SDKException

Adds a local file to the files collection and uploads it to the specified folder under the default folder for this InfoObject on the file repository server using the specified prefix and extension. The file name is randomly chosen by the server, provided it is unique among the files in the same directory.

Parameters:
file - The local file to be added.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, the local file's extension will be used.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process was unsuccessful.

addUniqueFile

public ILocalFile addUniqueFile(byte[] stream,
                                java.lang.String prefix,
                                java.lang.String ext,
                                java.lang.String subDir)
                         throws SDKException

Adds a local stream to the files collection and uploads it to the specified folder under the default folder for this InfoObject on the file repository server using the specified prefix and extension. The file name is randomly chosen by the server provided it is unique among the files in the same directory.

Parameters:
stream - The byte array to be added.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, the local file's extension will be used.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
Returns:
A local file object representing the local stream.
Throws:
SDKException - This is thrown if the process was unsuccessful.

addUniqueFile

public ILocalFile addUniqueFile(java.lang.String filePath,
                                boolean deleteLocalFile)
                         throws SDKException

This is a shortcut for addUniqueFile(filePath, null, null, null, deleteLocalFile) .

Parameters:
filePath - The local file's path.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process was unsuccessful.

addUniqueFile

public ILocalFile addUniqueFile(java.io.File file,
                                boolean deleteLocalFile)
                         throws SDKException

This is a shortcut for addUniqueFile(file, null, null, null, deleteLocalFile).

Parameters:
file - The local file to be added.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process was unsuccessful.

addUniqueFile

public ILocalFile addUniqueFile(java.lang.String filePath)
                         throws SDKException

This is a shortcut for addUniqueFile(filePath, false).

Parameters:
filePath - The local file's path.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process was unsuccessful.

addUniqueFile

public ILocalFile addUniqueFile(java.io.File file)
                         throws SDKException

This is a shortcut for addUniqueFile(file, false).

Parameters:
file - The local file to be added.
Returns:
A local file object representing the local file.
Throws:
SDKException - This is thrown if the process was unsuccessful.

addUniqueFile

public ILocalFile addUniqueFile(byte[] stream)
                         throws SDKException

This is a shortcut for addUnique(stream, null, null, null).

Parameters:
stream - The byte array to be added.
Returns:
A local file object representing the local stream.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replace

public IFile replace(int index,
                     java.lang.String filePath,
                     java.lang.String prefix,
                     java.lang.String ext,
                     java.lang.String destFilename,
                     java.lang.String subDir,
                     boolean deleteLocalFile)
              throws SDKException

Replaces an existing file in the files collection with a new local file. The local file is uploaded to the specified destination on the file server. The file is added in the same way as calling the addFile(filePath, prefix, ext, destFilename, subDir, deleteLocalFile) method.

Parameters:
index - The index of the object to be replaced.
filePath - The local file's path.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, no suffix will be added to the destination file name.
destFilename - The destination file name, excluding the prefix and suffix. That is, if destFileName is not null, the final file name will be <prefix><destFileName>.<ext>. If the destFileName is null, the destination file will have the same name as the local file.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replace

public IFile replace(int index,
                     java.io.File file,
                     java.lang.String prefix,
                     java.lang.String ext,
                     java.lang.String destFilename,
                     java.lang.String subDir,
                     boolean deleteLocalFile)
              throws SDKException

Replaces an existing file in the files collection with a new local file. The local file is uploaded to the specified destination on the file server. The file is added in the same way as calling the addFile(file, prefix, ext, destFilename, subDir, deleteLocalFile) method

Parameters:
index - The index of the object to be replaced.
file - The local file that will replace the current file.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, no suffix will be added to the destination file name.
destFilename - The destination file name, excluding the prefix and suffix. That is, if destFileName is not null, the final file name will be <prefix><destFileName>.<ext>. If the destFileName is null, the destination file will have the same name as the local file.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replace

public IFile replace(int index,
                     byte[] stream,
                     java.lang.String prefix,
                     java.lang.String ext,
                     java.lang.String destFilename,
                     java.lang.String subDir)
              throws SDKException

Replaces an existing file in the files collection with a new local file. The local file is uploaded to the specified destination on the file server. The file is added in the same way as calling the addFile(stream, prefix, ext, destFilename, subDir) method.

Parameters:
index - The index of the object to be replaced.
stream - The byte array to be added.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, no suffix will be added to the destination file name.
destFilename - The destination file name, excluding the prefix and suffix. The final file name will be <prefix><destFileName>.<ext>.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replace

public IFile replace(int index,
                     java.lang.String filePath,
                     boolean deleteLocalFile)
              throws SDKException

The shortcut for replace(index, filePath, null, null, null, null, deleteLocalFile).

Parameters:
index - The index of the object to be replaced.
filePath - The local file's path.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replace

public IFile replace(int index,
                     java.io.File file,
                     boolean deleteLocalFile)
              throws SDKException

The shortcut for replace(index, file, null, null, null, null, deleteLocalFile).

Parameters:
index - The index of the object to be replaced.
file - The local file that will replace the current file.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replace

public IFile replace(int index,
                     java.lang.String filePath)
              throws SDKException

The shortcut for replace(index, filePath, false).

Parameters:
index - The index of the object to be replaced.
filePath - The local file's path.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replace

public IFile replace(int index,
                     java.io.File file)
              throws SDKException

The shortcut for replace(index, file, false).

Parameters:
index - The index of the object to be replaced.
file - The local file that will replace the current file.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replaceUnique

public IFile replaceUnique(int index,
                           java.lang.String filePath,
                           java.lang.String prefix,
                           java.lang.String ext,
                           java.lang.String subDir,
                           boolean deleteLocalFile)
                    throws SDKException

Replaces an existing file in the files collection with a new local file. The local file is uploaded to the specified destination on the file server. The file is added in the same way as calling the addUniqueFile(filePath, prefix, ext, subDir, deleteLocalFile) method.

Parameters:
index - The index of the object to be replaced.
filePath - The local file's path.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, no suffix will be added to the destination file name.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replaceUnique

public IFile replaceUnique(int index,
                           java.io.File file,
                           java.lang.String prefix,
                           java.lang.String ext,
                           java.lang.String subDir,
                           boolean deleteLocalFile)
                    throws SDKException

Replaces an existing file in the files collection with a new local file. The local file is uploaded to the specified destination on the file server. The file is added in the same way as calling the addUniqueFile(filePath, prefix, ext, subDir, deleteLocalFile) method.

Parameters:
index - The index of the object to be replaced.
file - The local file that will replace the current file.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, no suffix will be added to the destination file name.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replaceUnique

public IFile replaceUnique(int index,
                           byte[] stream,
                           java.lang.String prefix,
                           java.lang.String ext,
                           java.lang.String subDir)
                    throws SDKException

Replaces an existing file in the files collection with a new local file. The local file is uploaded to the specified destination on the file server. The file is added in the same way as calling the addUniqueFile(filePath, prefix, ext, subDir, deleteLocalFile) method.

Parameters:
index - The index of the object to be replaced.
stream - The byte array to be added.
prefix - The prefix of the destination file name. When this argument is null, no prefix will be added to the destination file name.
ext - The extension of the destination file name. When this argument is null, no suffix will be added to the destination file name.
subDir - The sub-directory under the destination directory. If null, no subDir will be added.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replaceUnique

public IFile replaceUnique(int index,
                           java.lang.String filePath,
                           boolean deleteLocalFile)
                    throws SDKException

The shortcut for replaceUnique(index, filePath, null, null, deleteLocalFile).

Parameters:
index - The index of the object to be replaced.
filePath - The local file's path.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replaceUnique

public IFile replaceUnique(int index,
                           java.io.File file,
                           boolean deleteLocalFile)
                    throws SDKException

The shortcut for replaceUnique(index, file, null, null, deleteLocalFile).

Parameters:
index - The index of the object to be replaced.
file - The local file that will replace the current file.
deleteLocalFile - This is true if the local file needs to be deleted after the transaction is committed and false if the local file should be kept.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replaceUnique

public IFile replaceUnique(int index,
                           java.lang.String filePath)
                    throws SDKException

The shortcut for replaceUnique(index, filePath, false).

Parameters:
index - The index of the object to be replaced.
filePath - The local file's path.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replaceUnique

public IFile replaceUnique(int index,
                           java.io.File file)
                    throws SDKException

The shortcut for replaceUnique(index, file, false).

Parameters:
index - The index of the object to be replaced.
file - The local file that will replace the current file.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

replaceUnique

public IFile replaceUnique(int index,
                           byte[] stream)
                    throws SDKException

The shortcut for replaceUnique(index, stream, null, null, null).

Parameters:
index - the index of the object to be replaced.
stream - The byte array to be added.
Returns:
The old file object.
Throws:
SDKException - This is thrown if the process was unsuccessful.

commit

public void commit()
            throws SDKException

Commits all changes to the file repository server.

Throws:
SDKException - This is thrown if the process is unsuccessful.

abort

public void abort()

Aborts all changes made to the file repository server.


copy

public IFiles copy(java.lang.String destPath)
            throws SDKException

Copies this IFiles object to the specified path.

Parameters:
destPath - The path of the destination where the file will be copied to.
Returns:
An IFiles object containing the copied files.
Throws:
SDKException

properties

public IProperties properties()

Returns the property bag for this files object.

Returns:
An IProperties object containing the property bag for this files object.

getFRSPathURL

public java.lang.String getFRSPathURL()

Returns the URL to the File Repository Server path.

Returns:
A String containing the URL to the FRS path.