com.ibm.ftt.projects.zos.zoslogical
Interface LZOSResource

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, ILogicalResource, IRemoteResource
All Known Subinterfaces:
LZOSDataSet, LZOSDataSetMember, LZOSPartitionedDataSet, LZOSSequentialDataSet

public interface LZOSResource
extends IRemoteResource

A logical zOS resource.


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 String getCharset()
           
 com.ibm.ftt.resources.zos.mapping.MVSFileMapping getMVSFileMapping()
          Returns a new MVS file mapping object representing the mapping attributes actually applied to this resource.
 com.ibm.ftt.resources.zos.mapping.MVSFileMapping getMVSFileMappingOverride()
          Returns a copy of MVS file mapping object representing the mapping override for this specific resource.
 LZOSProject getProject()
          Returns the project associated with this logical resource.
 String getReference()
          Returns the name of the data set for which this resource is an alias if this is a data set alias.
 LZOSSubProject getSubProject()
          Returns the subproject associated with this logical resource.
 boolean isAlias()
          Determines whether this data set is an alias or not.
 boolean isMigrated()
          Determines whether this data set or the data set to which this resource belongs is migrated or not.
 boolean isOfflineVolume()
          Returns true if the volume this resource is on is currently offline.
 void setMVSFileMappingOverride(com.ibm.ftt.resources.zos.mapping.MVSFileMapping mapping)
          Sets a mapping override to this resource.
 
Methods inherited from interface com.ibm.ftt.projects.core.logical.IRemoteResource
exists, getSystem, goOffline, goOnline, refersTo
 
Methods inherited from interface com.ibm.ftt.projects.core.logical.ILogicalResource
delete, deleteOverriddenPropertiesInCategory, deleteOverride, getCurrentPropertyGroup, getFullPath, getLogicalParent, getName, getOverriddenProperties, getPersistentProperty, getPhysicalResource, getResourcePublisher, getSessionProperty, refresh, remove, rename, setCurrentPropertyGroup, setOverride, setPersistentProperty, setSessionProperty
 

Field Detail

COPY_RIGHT

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

getSubProject

LZOSSubProject getSubProject()
Returns the subproject associated with this logical resource.

Specified by:
getSubProject in interface ILogicalResource
Returns:
the LZOSSubProject associated with this logical resource

getProject

LZOSProject getProject()
Returns the project associated with this logical resource.

Returns:
the LZOSProject associated with this logical resource

isMigrated

boolean isMigrated()
Determines whether this data set or the data set to which this resource belongs is migrated or not.

Returns:
true if this data set is migrated; false otherwise
See Also:
LZOSDataSet.migrate(boolean, IProgressMonitor), LZOSDataSet.recall(boolean, IProgressMonitor), LZOSDataSet.hdelete(boolean, IProgressMonitor)

isAlias

boolean isAlias()
Determines whether this data set is an alias or not.

Returns:
true if the data set is an alias; false otherwise.

getReference

String getReference()
Returns the name of the data set for which this resource is an alias if this is a data set alias.

If this is a member of a data set alias, it returns the name of the data set for which the resource's parent is an alias.

Returns an empty string if the resource is not a data set alias (or a member of a data set alias) or the reference name could not be obtained

Returns:
a String containing the name of the referenced data set or an empty string.

isOfflineVolume

boolean isOfflineVolume()
Returns true if the volume this resource is on is currently offline.

Returns:
true if the volume is offline, false if it is online

getCharset

String getCharset()
                  throws OperationFailedException
Returns:
the name of the char set that should be used to interpret the contents of this resource.
Throws:
OperationFailedException
See Also:
#getContents(), {@link IPhysicalFile#getCharset()}

getMVSFileMappingOverride

com.ibm.ftt.resources.zos.mapping.MVSFileMapping getMVSFileMappingOverride()
Returns a copy of MVS file mapping object representing the mapping override for this specific resource.

The returned mapping contains value for overridden attributes, or null for attributes to be inherited. Changing the mapping object itself does not affects this resource. To apply any changes, it must be set by calling setMVSFileMappingOverride(MVSFileMapping).

Returns:
the mapping object associated with this resource. If this resource has no such mapping override, creates a new blank mapping object and returns it
See Also:
setMVSFileMappingOverride(MVSFileMapping), getMVSFileMapping()

getMVSFileMapping

com.ibm.ftt.resources.zos.mapping.MVSFileMapping getMVSFileMapping()
Returns a new MVS file mapping object representing the mapping attributes actually applied to this resource.

The returned mapping contains values determined by merging all the inherited values and overridden values defined through z/OS File System Mapping view and resource property pages. Changing the mapping object itself does not affects this resource. If any mapping attributes need to be changed for this specific resource, mapping override can be set by calling setMVSFileMappingOverride(MVSFileMapping).

Returns:
the mapping object that contains values actually applied to this resource
See Also:
getMVSFileMappingOverride(), setMVSFileMappingOverride(MVSFileMapping)

setMVSFileMappingOverride

void setMVSFileMappingOverride(com.ibm.ftt.resources.zos.mapping.MVSFileMapping mapping)
Sets a mapping override to this resource.

The mapping can contain values to override inherited attributes, or null for attributes to be inherited.

When this method is called, UI refresh may occur according to the setting, for example, file extension change, etc.

Parameters:
mapping - the mapping object to set. If null is specified, mapping override will be cleaned from this resource
See Also:
getMVSFileMappingOverride(), S