com.ibm.ftt.projects.core.logical
Interface ILogicalFile

All Superinterfaces:
IAdaptable, ILogicalResource
All Known Subinterfaces:
LZOSDataSetMember, LZOSSequentialDataSet

public interface ILogicalFile
extends ILogicalResource

Represents a remote file, such as a partitioned data set member or a sequential data set.


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 String getCharset()
           
 InputStream getContents()
          Returns a stream which may be used to read the contents of this file.
 String getFileExtension()
           Returns the extension of this logical file.
 String getNameWithoutExtension()
           Returns the base name of this logical file.
 
Methods inherited from interface com.ibm.ftt.projects.core.logical.ILogicalResource
delete, deleteOverriddenPropertiesInCategory, deleteOverride, getCurrentPropertyGroup, getFullPath, getLogicalParent, getName, getOverriddenProperties, getPersistentProperty, getPhysicalResource, getResourcePublisher, getSessionProperty, getSubProject, refresh, remove, rename, setCurrentPropertyGroup, setOverride, setPersistentProperty, setSessionProperty
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Field Detail

COPY_RIGHT

static final String COPY_RIGHT
See Also:
Constant Field Values
Method Detail

getNameWithoutExtension

String getNameWithoutExtension()

Returns the base name of this logical file. The definition of the base name is file system dependent.

For the MVS file system, file extensions created due to the remote mapping settings are not considered part of the base name.

Returns:
the base name string.

getFileExtension

String getFileExtension()

Returns the extension of this logical file. The base name is not included. The definition of the base name is file system dependent.

For the MVS file system, file extensions are created due to the remote mapping settings, and are not considered part of the base name.

Returns:
a String containing this file's extension

getCharset

String getCharset()
                  throws OperationFailedException
Returns:
the name of the char set that should be used to interpret the contents of this file.
Throws:
OperationFailedException
See Also:
ILogicalFile.getContents()

getContents

InputStream getContents()
                        throws OperationFailedException
Returns a stream which may be used to read the contents of this file.

Returns:
an InputStream from which to read the contents
Throws:
OperationFailedException
See Also:
#getCharset()}