iSeries Remote Systems
v6.0.0

com.ibm.etools.systems.as400filesubsys
Interface FileSubSystem

All Superinterfaces:
AS400SubSystem, org.eclipse.emf.ecore.EObject, IISeriesSubSystem, IISeriesSubSystemCommandExecutionProperties, com.ibm.etools.systems.subsystems.IRemoteObjectResolver, org.eclipse.emf.common.notify.Notifier, com.ibm.etools.systems.subsystems.SubSystem, com.ibm.etools.systems.filters.SystemFilterPoolReferenceManagerProvider
All Known Implementing Classes:
FileSubSystemImpl

public interface FileSubSystem
extends IISeriesSubSystem, AS400SubSystem, IISeriesSubSystemCommandExecutionProperties


Field Summary
static String copyright
           
 
Fields inherited from interface com.ibm.etools.iseries.core.IISeriesSubSystem
Copyright
 
Fields inherited from interface com.ibm.etools.iseries.core.IISeriesSubSystemCommandExecutionProperties
Copyright
 
Method Summary
 boolean copyLibrary(Shell shell, ISeriesLibrary srcLibrary, ISeriesConnection tgtConnection, String newName, boolean processCmdLineParm)
          Copy a given library to a new library of the given name in the given connection
 boolean copyMember(Shell shell, ISeriesMember srcMember, ISeriesObject tgtFile, String newName, boolean processCmdLineParm)
          Copy a given member to the given file
 boolean copyObject(Shell shell, ISeriesObject srcObject, ISeriesLibrary tgtLibrary, String newName, boolean processCmdLineParm)
          Copy a given object to the given library
 String getExtraAttributes()
           
 String getInternalJobDescription()
           
 String getInternalObjectLibrary()
           
 String getInternalSBMJOBParms()
           
 boolean isInternalCompileInBatch()
           
 boolean isInternalReplaceObject()
           
 boolean isInternalRunInBatch()
           
 boolean isSetInternalCompileInBatch()
          Returns whether the value of the 'Internal Compile In Batch' attribute is set.
 boolean isSetInternalJobDescription()
          Returns whether the value of the 'Internal Job Description' attribute is set.
 boolean isSetInternalObjectLibrary()
          Returns whether the value of the 'Internal Object Library' attribute is set.
 boolean isSetInternalReplaceObject()
          Returns whether the value of the 'Internal Replace Object' attribute is set.
 boolean isSetInternalRunInBatch()
          Returns whether the value of the 'Internal Run In Batch' attribute is set.
 boolean isSetInternalSBMJOBParms()
          Returns whether the value of the 'Internal SBMJOB Parms' attribute is set.
 boolean moveMember(Shell shell, ISeriesMember srcMember, ISeriesObject tgtFile, String newName, boolean processCmdLineParm)
          Move a given member to the given file
 boolean moveObject(Shell shell, ISeriesObject srcObject, ISeriesLibrary tgtLibrary, String newName, boolean processCmdLineParm)
          Move a given object to the given library
 void setExtraAttributes(String value)
           
 void setInternalCompileInBatch(boolean value)
           
 void setInternalJobDescription(String value)
           
 void setInternalObjectLibrary(String value)
           
 void setInternalReplaceObject(boolean value)
           
 void setInternalRunInBatch(boolean value)
           
 void setInternalSBMJOBParms(String value)
           
 void unsetInternalCompileInBatch()
          Unsets the value of the 'Internal Compile In Batch' attribute.
 void unsetInternalJobDescription()
          Unsets the value of the 'Internal Job Description' attribute.
 void unsetInternalObjectLibrary()
          Unsets the value of the 'Internal Object Library' attribute.
 void unsetInternalReplaceObject()
          Unsets the value of the 'Internal Replace Object' attribute.
 void unsetInternalRunInBatch()
          Unsets the value of the 'Internal Run In Batch' attribute.
 void unsetInternalSBMJOBParms()
          Unsets the value of the 'Internal SBMJOB Parms' attribute.
 com.ibm.etools.systems.core.messages.SystemMessage uploadSaveFile(Shell shell, String fullyQualifiedLocalFileName, String saveFileLibrary, String saveFileName)
          Upload a local save file to an iSeries save file
 
Methods inherited from interface com.ibm.etools.iseries.core.IISeriesSubSystem
getCmdSubSystem, getCommandExecutionProperties, getISeriesSystem, getObjectSubSystem, getShell, getToolboxAS400Object, setShell
 
Methods inherited from interface com.ibm.etools.systems.subsystems.SubSystem
checkIsConnected, clearLocalUserId, connect, connect, connect, deletingConnection, disconnect, disconnect, doesFilterListContentsOf, doesFilterMatch, doesFilterStringListContentsOf, doesFilterStringMatch, forceUserIdToUpperCase, getAdditionalAttributes, getCacheManager, getChildren, getCommandSubSystem, getFactoryId, getFilterPoolReferenceManager, getIbmAttributes, getLocalUserId, getName, getParentSubSystemFactory, getPort, getPortAsInt, getProperties, getProperty, getPropertyPage, getRemoteServerLauncher, getSaveFileName, getSystem, getSystemConnection, getSystemConnectionName, getSystemFilterPoolReferenceManager, getSystemManager, getSystemProfile, getSystemProfileName, getTargetForFilter, getUDActionSubsystem, getUserId, getVendorAttribute, getVendorAttributes, hasChildren, isConnected, isHidden, isOffline, isSetAdditionalAttributes, isSetIbmAttributes, isSetVendorAttributes, isUseSSL, renamingConnection, renamingProfile, resolveFilterString, resolveFilterString, resolveFilterString, resolveFilterString, resolveFilterStrings, resolveFilterStrings, setAdditionalAttributes, setFactoryId, setFilterPoolReferenceManager, setHidden, setIbmAttributes, setName, setParentConnection, setParentSubSystemFactory, setPort, setProperties, setProperty, setRemoteServerLauncher, setSaveFileName, setUserId, setUseSSL, setVendorAttribute, setVendorAttributes, supportsCaching, unsetAdditionalAttributes, unsetIbmAttributes, unsetVendorAttributes
 
Methods inherited from interface com.ibm.etools.systems.filters.SystemFilterPoolReferenceManagerProvider
filterEventFilterCreated, filterEventFilterPoolReferenceCreated, filterEventFilterPoolReferenceDeleted, filterEventFilterPoolReferenceRenamed, filterEventFilterPoolReferenceReset, filterEventFilterPoolReferencesRePositioned, filterEventFilterPoolReferencesReset, filterEventFilterStringCreated, getUniqueOwningSystemFilterPool
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface com.ibm.etools.systems.subsystems.IRemoteObjectResolver
getObjectWithAbsoluteName
 
Methods inherited from interface com.ibm.etools.iseries.core.IISeriesSubSystemCommandExecutionProperties
getCompileInBatch, getJobDescription, getObjectLibrary, getReplaceObject, getRunInBatch, getSBMJOBParms
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

copyLibrary

public boolean copyLibrary(Shell shell,
                           ISeriesLibrary srcLibrary,
                           ISeriesConnection tgtConnection,
                           String newName,
                           boolean processCmdLineParm)
                    throws Exception
Copy a given library to a new library of the given name in the given connection

Throws:
Exception

copyObject

public boolean copyObject(Shell shell,
                          ISeriesObject srcObject,
                          ISeriesLibrary tgtLibrary,
                          String newName,
                          boolean processCmdLineParm)
                   throws Exception
Copy a given object to the given library

Throws:
Exception

moveObject

public boolean moveObject(Shell shell,
                          ISeriesObject srcObject,
                          ISeriesLibrary tgtLibrary,
                          String newName,
                          boolean processCmdLineParm)
                   throws Exception
Move a given object to the given library

Throws:
Exception

copyMember

public boolean copyMember(Shell shell,
                          ISeriesMember srcMember,
                          ISeriesObject tgtFile,
                          String newName,
                          boolean processCmdLineParm)
                   throws Exception
Copy a given member to the given file

Throws:
Exception

moveMember

public boolean moveMember(Shell shell,
                          ISeriesMember srcMember,
                          ISeriesObject tgtFile,
                          String newName,
                          boolean processCmdLineParm)
                   throws Exception
Move a given member to the given file

Throws:
Exception

uploadSaveFile

public com.ibm.etools.systems.core.messages.SystemMessage uploadSaveFile(Shell shell,
                                                                         String fullyQualifiedLocalFileName,
                                                                         String saveFileLibrary,
                                                                         String saveFileName)
Upload a local save file to an iSeries save file


getExtraAttributes

public String getExtraAttributes()
Returns:
The value of the ExtraAttributes attribute

setExtraAttributes

public void setExtraAttributes(String value)
Parameters:
value - The new value of the ExtraAttributes attribute

getInternalJobDescription

public String getInternalJobDescription()
Returns:
The value of the InternalJobDescription attribute Job Description for batch submissions. Qualified by library

setInternalJobDescription

public void setInternalJobDescription(String value)
Parameters:
value - The new value of the InternalJobDescription attribute

unsetInternalJobDescription

public void unsetInternalJobDescription()
Unsets the value of the 'Internal Job Description' attribute.

See Also:
isSetInternalJobDescription(), getInternalJobDescription(), setInternalJobDescription(String)

isSetInternalJobDescription

public boolean isSetInternalJobDescription()
Returns whether the value of the 'Internal Job Description' attribute is set.

Returns:
whether the value of the 'Internal Job Description' attribute is set.
See Also:
unsetInternalJobDescription(), getInternalJobDescription(), setInternalJobDescription(String)

getInternalObjectLibrary

public String getInternalObjectLibrary()
Returns:
The value of the InternalObjectLibrary attribute Target library when doing compiles

setInternalObjectLibrary

public void setInternalObjectLibrary(String value)
Parameters:
value - The new value of the InternalObjectLibrary attribute

unsetInternalObjectLibrary

public void unsetInternalObjectLibrary()
Unsets the value of the 'Internal Object Library' attribute.

See Also:
isSetInternalObjectLibrary(), getInternalObjectLibrary(), setInternalObjectLibrary(String)

isSetInternalObjectLibrary

public boolean isSetInternalObjectLibrary()
Returns whether the value of the 'Internal Object Library' attribute is set.

Returns:
whether the value of the 'Internal Object Library' attribute is set.
See Also:
unsetInternalObjectLibrary(), getInternalObjectLibrary(), setInternalObjectLibrary(String)

isInternalRunInBatch

public boolean isInternalRunInBatch()
Returns:
The value of the InternalRunInBatch attribute Run commands in batch, by default?

setInternalRunInBatch

public void setInternalRunInBatch(boolean value)
Parameters:
value - The new value of the InternalRunInBatch attribute

unsetInternalRunInBatch

public void unsetInternalRunInBatch()
Unsets the value of the 'Internal Run In Batch' attribute.

See Also:
isSetInternalRunInBatch(), isInternalRunInBatch(), setInternalRunInBatch(boolean)

isSetInternalRunInBatch

public boolean isSetInternalRunInBatch()
Returns whether the value of the 'Internal Run In Batch' attribute is set.

Returns:
whether the value of the 'Internal Run In Batch' attribute is set.
See Also:
unsetInternalRunInBatch(), isInternalRunInBatch(), setInternalRunInBatch(boolean)

isInternalCompileInBatch

public boolean isInternalCompileInBatch()
Returns:
The value of the InternalCompileInBatch attribute Compile in batch, by default?

setInternalCompileInBatch

public void setInternalCompileInBatch(boolean value)
Parameters:
value - The new value of the InternalCompileInBatch attribute

unsetInternalCompileInBatch

public void unsetInternalCompileInBatch()
Unsets the value of the 'Internal Compile In Batch' attribute.

See Also:
isSetInternalCompileInBatch(), isInternalCompileInBatch(), setInternalCompileInBatch(boolean)

isSetInternalCompileInBatch

public boolean isSetInternalCompileInBatch()
Returns whether the value of the 'Internal Compile In Batch' attribute is set.

Returns:
whether the value of the 'Internal Compile In Batch' attribute is set.
See Also:
unsetInternalCompileInBatch(), isInternalCompileInBatch(), setInternalCompileInBatch(boolean)

isInternalReplaceObject

public boolean isInternalReplaceObject()
Returns:
The value of the InternalReplaceObject attribute Replace target object when compiling?

setInternalReplaceObject

public void setInternalReplaceObject(boolean value)
Parameters:
value - The new value of the InternalReplaceObject attribute

unsetInternalReplaceObject

public void unsetInternalReplaceObject()
Unsets the value of the 'Internal Replace Object' attribute.

See Also:
isSetInternalReplaceObject(), isInternalReplaceObject(), setInternalReplaceObject(boolean)

isSetInternalReplaceObject

public boolean isSetInternalReplaceObject()
Returns whether the value of the 'Internal Replace Object' attribute is set.

Returns:
whether the value of the 'Internal Replace Object' attribute is set.
See Also:
unsetInternalReplaceObject(), isInternalReplaceObject(), setInternalReplaceObject(boolean)

getInternalSBMJOBParms

public String getInternalSBMJOBParms()
Returns:
The value of the InternalSBMJOBParms attribute Additional user-specified parameters to append to SBMJOB whenever appropriate

setInternalSBMJOBParms

public void setInternalSBMJOBParms(String value)
Parameters:
value - The new value of the InternalSBMJOBParms attribute

unsetInternalSBMJOBParms

public void unsetInternalSBMJOBParms()
Unsets the value of the 'Internal SBMJOB Parms' attribute.

See Also:
isSetInternalSBMJOBParms(), getInternalSBMJOBParms(), setInternalSBMJOBParms(String)

isSetInternalSBMJOBParms

public boolean isSetInternalSBMJOBParms()
Returns whether the value of the 'Internal SBMJOB Parms' attribute is set.

Returns:
whether the value of the 'Internal SBMJOB Parms' attribute is set.
See Also:
unsetInternalSBMJOBParms(), getInternalSBMJOBParms(), setInternalSBMJOBParms(String)

iSeries Remote Systems
v6.0.0

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.