iSeries Remote Systems
v6.0.0

com.ibm.etools.iseries.core.resources
Class ISeriesEditableSrcPhysicalFileMember

java.lang.Object
  extended bycom.ibm.etools.iseries.core.resources.ISeriesEditableSrcPhysicalFileMember
All Implemented Interfaces:
com.ibm.etools.systems.subsystems.ICommunicationsListener, IISeriesRemoteEditConstants, IPartListener, ISeriesDataStoreConstants, com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject, com.ibm.etools.systems.core.resources.ISystemRemoteEditConstants, com.ibm.etools.systems.core.resources.ISystemTextEditorConstants

public class ISeriesEditableSrcPhysicalFileMember
extends Object
implements com.ibm.etools.systems.subsystems.ICommunicationsListener, IPartListener, com.ibm.etools.systems.core.resources.ISystemTextEditorConstants, com.ibm.etools.systems.core.resources.ISystemRemoteEditConstants, IISeriesRemoteEditConstants, com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject, ISeriesDataStoreConstants

A representation of a remote iSeries source member for the purpose of local editing


Field Summary
static String Copyright
           
 
Fields inherited from interface com.ibm.etools.systems.subsystems.ICommunicationsListener
copyright
 
Fields inherited from interface com.ibm.etools.systems.core.resources.ISystemTextEditorConstants
CCSID_KEY, EDITOR_PROFILE_TYPE, LOCAL_ENCODING_KEY, MAX_LINE_LENGTH_KEY, SEQUENCE_NUMBERS_KEY, SOURCE_ENCODING_KEY, SYSTEM_TEXT_BROWSER_ID, SYSTEM_TEXT_EDITOR_ID, TEMP_CCSID_KEY
 
Fields inherited from interface com.ibm.etools.systems.core.resources.ISystemRemoteEditConstants
DEFAULT_EDITOR_PROFILE, DOWNLOAD_FILE_MODIFIED_STAMP, EDITOR_COMPARE_LOCATION, EDITOR_GET_FILE_LOCATION, LOAD_TYPE_KEY, LOAD_TYPE_USE_STRING, REMOTE_FILE_BINARY_TRANSFER, REMOTE_FILE_MODIFIED_STAMP, REMOTE_FILE_MOUNTED, REMOTE_FILE_OBJECT_KEY, REMOTE_FILE_PATH_KEY, REMOTE_FILE_SUBSYSTEM_KEY, RESOLVED_MOUNTED_REMOTE_FILE_HOST_KEY, RESOLVED_MOUNTED_REMOTE_FILE_PATH_KEY, TEMP_FILE_DIRTY, TEMP_FILE_READONLY, UNIVERSAL_EDITOR_PROFILE, UNIVERSAL_LOCAL_EDITOR_PROFILE
 
Fields inherited from interface com.ibm.etools.iseries.core.resources.IISeriesRemoteEditConstants
AS400_OBJECT_KEY, IFS_EDITOR_PROFILE, QSYS_EDITOR_PROFILE
 
Fields inherited from interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
NOT_OPEN, OPEN_IN_DIFFERENT_PERSPECTIVE, OPEN_IN_SAME_PERSPECTIVE
 
Fields inherited from interface com.ibm.etools.iseries.core.dstore.common.ISeriesDataStoreConstants
ABSTRACT_FILTER_DESCRIPTOR, ABSTRACT_NATIVE_FSO_DESCRIPTOR, API_ERROR, API_ERROR_DESCRIPTOR, API_OK, API_PTF_MISSING, API_RESULT_DESCRIPTOR, API_RETURN_CODE, AUTHORITY_LIST_NODE, AUTHORITY_NODE, BATCHCOMMAND_DESCRIPTOR, C_GET_EDIT_CCSID, C_LDA_READ, C_LDA_WRITE, C_USER_PREFERENCES_DIRECTORY, CCSID_DESCRIPTOR, CDRA_INFO, CHECK_AUTHORITY_COMMAND, CLEAR_LOCAL_CACHE, CMD_DEBUG_RELEASE_APPLICATION, CMD_DEBUG_SPAWN_AND_HOLD, CMD_GET_DEBUG_ROUTER_PORT, CMD_IJOB_ASSOCIATE, CMD_IJOB_RELEASE, CMD_IJOB_RUNPGM, CMD_MULTI_SPAWNFAIL, CMD_MULTI_SPAWNSUCC, CMD_RUNBATCHCOMMAND, CMD_RUNBATCHCOMMAND_NOHELP, CMD_RUNCOMMAND, CMD_RUNCOMMAND_MULTITHREADED, CMD_RUNCOMMAND_MULTITHREADED_NOHELP, CMD_RUNCOMMAND_NOHELP, COMM_SERVER_INFORMATION, COMMAND_DESCRIPTOR, COMMAND_FILTER_DESCRIPTOR, COMMAND_MINER, COMMAND_MINER_ROOT_ELEMENT, COMMAND_QUERY_DB_FIELDS, COMMAND_QUERY_DB_KEYS, COMMAND_QUERY_DSPF_ALL, COMMAND_QUERY_MODULE_LIST, COMMAND_QUERY_PROCEDURE_LIST, copyright, CREATE_EDIT_MASK, CURRENT_WORKING_DIR, CURRENT_WORKING_DIR_DESCRIPTOR, DBFIELD_ALIAS, DBFIELD_ALLOC_LENGTH, DBFIELD_ALWNUL, DBFIELD_CCSID_SPECIFIED, DBFIELD_COLHEAD1, DBFIELD_COLHEAD2, DBFIELD_COLHEAD3, DBFIELD_DATA_CCSID, DBFIELD_DATTIMFMT, DBFIELD_DATTIMSEP, DBFIELD_DBCS_ALTTYPE, DBFIELD_DBCS_COLHEAD, DBFIELD_DBCS_TEXTDESC, DBFIELD_DBCS_VALCHECK, DBFIELD_DECPOS, DBFIELD_DESCRIPTION, DBFIELD_DIGITS, DBFIELD_DISPLAY_LEN_FLAG, DBFIELD_DISPLAY_LENGTH, DBFIELD_DTFLAGS, DBFIELD_EDITCODE, DBFIELD_EDITCODE_SYMBOL, DBFIELD_EDITWORD, DBFIELD_ENCODING_SCHEME, DBFIELD_GENERIC_KEY_COUNT, DBFIELD_INBUF, DBFIELD_INTNAME, DBFIELD_KEYFIELD_ATTRS, DBFIELD_LENGTH, DBFIELD_MAXKEYLEN, DBFIELD_MIN_DISPLAY_LEN_FLAG, DBFIELD_NUMDBCS, DBFIELD_OPERATOR, DBFIELD_OUTBUF, DBFIELD_REF_FIELD, DBFIELD_REFSHIFT, DBFIELD_SST_END, DBFIELD_SST_START, DBFIELD_TYPE, DBFIELD_UCS2_CONVERT_FLAG, DBFIELD_USAGE, DBFIELD_VARLENGTH, DEBUG_HELD_JOB_DESCRIPTOR, DOWNLOAD_RESULT_AS400_SECURITY_EXCEPTION, DSPFFD_INBUF, DSPFFD_OUTBUF, EDCODE_CURSYM, EDCODE_DATESEP, EDCODE_DECSEP, EDCODE_JOBDESC, EDCODE_JOBDESCLIB, EDCODE_SYSDATE, EDCODE_TIMESEP, EDCODE_USERID, EDIT_CODE_DESCRIPTOR, EDIT_CODE_INFORMATION, EDIT_CODE_QUERY, EDIT_DESCRIPTION, EDIT_MASK_DESCRIPTOR, EDIT_MASK_INFO, EDTD_DECCHAR, EDTD_FILLCHAR, EDTD_FLOATSTR, EDTD_FRACTION_MASK, EDTD_INTMASK, EDTD_LEFTCHAR, EDTD_NEGCHAR, EDTD_POSCHAR, EDTD_RIGHTCHAR, EDTD_ZEROVAL, EDTM_RECLEN, ENVVAR_DESCRIPTOR, ENVVAR_INFO, ERROR_DESCRIPTOR, EVENTSFILE_DESCRIPTOR, FIELD_DESCRIPTOR, FIELD_LIST_NODE, FIELD_PROPERTIES_NODE, FILE_ACCPATHTYPE, FILE_ALTSEQ, FILE_BASEDONCOUNT, FILE_BASEDONFILES, FILE_DESCRIPTOR, FILE_DYNSEL, FILE_IGCFIELD, FILE_IGCLITERAL, FILE_JFILE, FILE_KEYACCESS, FILE_LANGID, FILE_OVERRIDE_INFO, FILE_OVERRIDE_SOURCE_DESCRIPTOR, FILE_OVERRIDE_TARGET_DESCRIPTOR, FILE_PROPERTIES_NODE, FILE_SELECTOMITLF, FILE_SRCFILE, IFS_FILE_FILTER_OBJECT, IFS_FILESYSTEM_MINER, IFS_FILTER_DESCRIPTOR, IFS_FOLDER_FILTER_OBJECT, IJOB_DATAQ_DESCRIPTOR, ISERIES_PROGRAM_DESCRIPTOR, JOB_DESCRIPTOR, JOB_FILTER_DESCRIPTOR, JOB_MINER, JOB_MINER_LOG_ELEMENT, JOB_MINER_ROOT_ELEMENT, JOB_PROPERTY_DESCRIPTOR, JOB_PROPERTY1_ELEMENT, JOB_PROPERTY2_ELEMENT, JOB_PROPERTY3_ELEMENT, JOB_PROPERTYINT_ELEMENT, JOBCMD_CHGJOB, JOBCMD_DSPJOBLOG, JOBCMD_ENDJOB, JOBCMD_ENDJOB_IMMED, JOBCMD_HOLDJOB, JOBCMD_QRYJOB_ALL_PROPERTIES, JOBCMD_QRYJOB_PROPERTY, JOBCMD_QRYJOB_PROPERTYP2, JOBCMD_QRYJOB_PROPERTYP3, JOBCMD_QRYJOB_PROPERTYPINT, JOBCMD_RELEASEJOB, JOBFILTERCMD_QUERY, JOBNAME_DESCRIPTOR, JOBPROP_ACCTCODE, JOBPROP_ACTIVESTATUS, JOBPROP_AUXIO, JOBPROP_BREAKMSGHDL, JOBPROP_CCSID, JOBPROP_CNTRYID, JOBPROP_CTLDENDREQ, JOBPROP_CURRSYSPOOL, JOBPROP_CURRUSER, JOBPROP_DATE_ENTERED, JOBPROP_DATE_STARTED, JOBPROP_DATEFMT, JOBPROP_DATESEP, JOBPROP_DBCSCAP, JOBPROP_DECFMT, JOBPROP_DESCRIPTION, JOBPROP_DEVRCYACT, JOBPROP_DFTCCSID, JOBPROP_ENDSEV, JOBPROP_INQMSGRPLY, JOBPROP_ITRANS, JOBPROP_KEEPDDMACT, JOBPROP_LANGID, JOBPROP_LOGCLP, JOBPROP_LOGLVL, JOBPROP_LOGSEV, JOBPROP_LOGTXT, JOBPROP_MAXCPU, JOBPROP_MAXTMPSTOR, JOBPROP_MSGQACT, JOBPROP_MSGQMAX, JOBPROP_OUTQ, JOBPROP_OUTQ_PTY, JOBPROP_PGMRC, JOBPROP_PRODRC, JOBPROP_PRTDEV, JOBPROP_PRTKEYFMT, JOBPROP_PRTTXT, JOBPROP_PURGE, JOBPROP_ROUTING, JOBPROP_RUNPTY, JOBPROP_SORTTAB, JOBPROP_SPECENV, JOBPROP_STATUSMSGHDL, JOBPROP_SUBMITNAME, JOBPROP_SUBMITNUMBER, JOBPROP_SUBMITUSER, JOBPROP_SUBSYSTEM, JOBPROP_SUBTYPE, JOBPROP_SWITCHES, JOBPROP_SYSPOOL, JOBPROP_THREADS, JOBPROP_TIMESEP, JOBPROP_TIMESLICE, JOBPROP_TIMESLICEPOOL, JOBPROP_TOTRESPTIME, JOBPROP_TYPE, JOBPROP_USEDCPU, JOBPROP_USEDTMPSTOR, JOBPROP_USERRC, JOBPROP_WAITTIME, KEYFIELD_LIST_NODE, KEYWORD_DESCRIPTOR, LDA_READ_EXCEPTION_DESCRIPTOR, LDA_READ_LIBRARY_NAME_DESCRIPTOR, LDA_READ_MEMBER_NAME_DESCRIPTOR, LDA_READ_NO_OUTPUT_DESCRIPTOR, LDA_WRITE_CCSID_DESCRIPTOR, LDA_WRITE_EXCEPTION_DESCRIPTOR, LDA_WRITE_LENGTH_DESCRIPTOR, LIB_FILTER_DESCRIPTOR, LIB_FILTER_STR_DESCRIPTOR, LIBRARY_DESCRIPTOR, LIBRARY_PROPERTIES_NODE, LIST_OBJ_LOCKS_COMMAND, MBR_FILTER_DESCRIPTOR, MBR_FILTER_STR_DESCRIPTOR, MEMBER_CHANGE_TIMESTAMP, MEMBER_CREATION_TIMESTAMP, MEMBER_DESCRIPTOR, MEMBER_NUMBER_OF_DELETED, MEMBER_NUMBER_OF_RECORDS, MEMBER_PROPERTIES_NODE, MEMBER_RESTOTE_TIMESTAMP, MEMBER_SAVE_TIMESTAMP, MESSAGE_DESCRIPTOR, MESSAGE_FILE_DESCRIPTOR, MESSAGED_DESCRIPTOR, MODULE_DESCRIPTOR, MODULE_INTERNAL_DESCRIPTOR, MODULE_LANGID, MODULE_LIST_NODE, MODULE_PROPERTIES_NODE, MSGD_STRUCTURE_NODE, NATIVE_FILESYSTEM_MINER, NETINT_DESCRIPTOR, NETINT_LIST_NODE, NETINT_QUERY, NETWORK_ERROR_DESCRIPTOR, OBJ_FILTER_DESCRIPTOR, OBJ_FILTER_STR_DESCRIPTOR, OBJECT_DESCRIPTOR, OBJECT_PROPERTIES_NODE, PGM_DEBUGGABLE, PGM_OPM, PROCEDURE_DESCRIPTOR, PROCEDURE_LIST_NODE, PROGRAM_DESCRIPTOR, PROPERTY_DESCRIPTOR, QSYS_DESCRIPTOR, QUERY_CURRENT_WORKING_DIR, QUERY_DEVICE_RECORDS, QUERY_ENCODING_SCHEME, QUERY_ENV_VAR, QUERY_FIELD_LIST, QUERY_FILE_PROPERTIES, QUERY_MEMBER_PROPERTIES, QUERY_MESSAGE_DESCRIPTORS_COMMAND, QUERY_RECORD_LIST, QUERY_RECORD_PROPERTIES, RECORD_BUFFER_SIZE, RECORD_CCSID, RECORD_DESC, RECORD_DESCRIPTOR, RECORD_DEVICE_PROPERTIES, RECORD_FLDCNT, RECORD_HAS_SEP_IND_AREA, RECORD_HAS_START_LINE_NUM, RECORD_ISDBCS, RECORD_LEVELID, RECORD_LIST_NODE, RECORD_LOWEST_RESP_IND, RECORD_PROPERTIES_NODE, RECORD_RECLEN, RECORD_STANDARD_PROPERTIES, RECORD_TYPE, RELATIVE_FILTER_DESCRIPTOR, RESULT_MESSAGES_ELEMENT, RETRIEVE_FILE_OVERRIDE_COMMAND, SERVICE_PROGRAM_DESCRIPTOR, SORT_SEQ_TABLE, SORT_SEQ_TABLE_INFO, SPECIAL_FILTER_DESCRIPTOR, SQL_COLERROR, SQL_COLFIRSTBYTE, SQL_COLLASTBYTE, SQL_DESCRIPTOR, SQL_MSGFILE, SQL_MSGID, SQL_MSGLIB, SQL_MSGREPLACELEN, SQL_MSGREPLACETEXT, SQL_NUMSTMT, SQL_RECERORR, SQL_RECFIRSTBYTE, SQL_RECLASTBYTE, SQL_RETINFOLEN, SQL_STATE, SQL_SYNTAX_CHECK, SQL_SYNTAX_CHECK_INFO, SST_BYTESAVAIL, SST_BYTESRETURN, SST_COUNTRYID, SST_JOBCCSID, SST_LANGID, SST_QUERY, SST_SSTLIB, SST_SSTNAME, SST_SUBSITUTION, SST_TABLE, SST_TABLECCSID, SST_TABLELIB, SST_TABLENAME, SST_WEIGHT, STRUCTURE_NODE_DESCRIPTOR, SYSTEM_INFORMATION, SYSTEM_PROPERTY_DESCRIPTOR, SYSTEM_QIGC, SYSTEM_VRM, TABLE_DESCRIPTOR
 
Constructor Summary
ISeriesEditableSrcPhysicalFileMember(ISeriesMember member)
          Constructor
ISeriesEditableSrcPhysicalFileMember(ISeriesMember member, boolean readonly)
          Constructor
 
Method Summary
 void addAsListener()
          Register as listener for various events
 boolean canWrite()
           
 int checkOpenInEditor()
          Is the local file open in an editor
 void closeStream()
          Close the member
 void communicationsStateChange(com.ibm.etools.systems.subsystems.CommunicationsEvent event)
           
 void connect()
          Connects and resets parameters, if not connected.
 void connect(Shell shell)
          Connects and resets parameters, if not connected.
 void delete()
          Delete the local resource
 boolean doImmediateSaveAndUpload()
          Saves the local file and uploads it to the host immediately, rather than, in response to a resource change event.
 boolean download(IProgressMonitor monitor)
          Download the member.
 boolean download(IProgressMonitor monitor, boolean force)
          Download the member.
 boolean download(IProgressMonitor monitor, boolean force, boolean doRefresh)
          Download the member.
 boolean download(Shell shell)
          Download the member.
 boolean download(Shell shell, boolean force)
          Download the member.
 boolean download(Shell shell, boolean force, boolean silent)
          Download the member.
 boolean download(Shell shell, boolean force, boolean silent, boolean doRefresh)
          Download the member.
 IFile getAndCreateLocalResource()
          Remote members that have been edited before are cached locally as an IFile in our own RSE tempfiles project.
 String getDownloadPath()
          Gets the download path
 String getDownloadPath(ISeriesMember rmember)
          Gets the download path
 com.ibm.etools.systems.editor.SystemTextEditor getEditor()
          Get the editor
 IEditorPart getEditorPart()
          Returns the open IEditorPart for this remote object if there is one.
 String getEditorTitle()
          Get editor title
 String getFullName()
          Return the fully qualified member name: library/object(member)
 ISeriesConnection getISeriesConnection()
          Returns the ISeriesConnection from which this object originated.
 IFile getLocalResource()
          Remote members that have been edited before are cached locally as an IFile in our own RSE tempfiles project.
 ISeriesMember getMember()
          Return the ISeriesMember object representing this member
protected  String getOSPath(String path)
           
static long getRemoteMemberTimestamp(ISeriesMember remoteMember)
           
 IAdaptable getRemoteObject()
          Returns the remote object that is editable
 String getRemotePath()
          Get the remote path.
 Verifier getVerifierForSourceType(String sourceType, IFile iFile)
          get the verifier for a source type and IFile
static Verifier getVerifierForSourceTypeStatic(String sourceType, IFile iFile)
          get the verifier for a source type and IFile
static boolean isCOBOLSourceType(String sourceType)
          check if there is source type is of type COBOL
 boolean isConnected()
          Returns if connection is connected
static boolean isDDSSourceType(String sourceType)
          check if there is source type is of type DDS
 boolean isDirty()
           
static boolean isILERRPGSourceType(String sourceType)
          check if there is source type is of type ILE RPG
 boolean isPassiveCommunicationsListener()
           
 boolean isReadOnly()
          is the editor readonly?
static boolean isVerifiableSourceType(String sourceType)
          check if there is a verifier, based on source type
static boolean isVerifiableWithPromptSourceType(String sourceType)
          check if there is a verifier that prompts for options, based on source type
 void open(Shell shell)
          Open member in editor for read / write.
 void open(Shell shell, boolean readOnly)
          Open in editor in specified mode.
 void openEditor()
          Open the editor
 boolean openIsCanceled()
          Return if the open is canceled or not
 boolean openStream()
          Open member for write.
 void partActivated(IWorkbenchPart part)
           
 void partBroughtToTop(IWorkbenchPart part)
           
 void partClosed(IWorkbenchPart part)
           
 void partDeactivated(IWorkbenchPart part)
           
 void partOpened(IWorkbenchPart part)
           
 com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock queryLocks()
          Query whether member is locked on the server.
 com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock queryLocks(ISeriesMember amember)
          Query whether member is locked on the server.
 void refresh()
          Refresh the remote edit project.
 boolean saveAs(ISeriesMember newMember, IProgressMonitor progressMonitor)
          Save as to a remote location
 void setContents(Shell shell, String[] contents, boolean upload)
          Set the contents of the member in its local copy, and optionally upload it to the host
 void setEditor(IEditorPart editor)
          Set the editor
 void setEditorAsReadOnly()
          Set editor to read only
 void setLocalResourceProperties()
          Set local resource properties
 void setLocalResourceProperties(boolean setCharset)
          Set local resource properties Normally this method is not called directly, use setLocalResourceProperties() instead which calls this one with a parameter of true.
 void setMember(ISeriesMember member)
          Set the remote member
 void setReadOnly(boolean flag)
           
 void setTrace(boolean tracing)
          Turn on tracing statements for debug purposes.
 void updateDirtyIndicator()
          Update the dirty indicator
 void upload(IProgressMonitor monitor)
          Upload the member to the iSeries.
 void upload(Shell shell)
          Upload the member to the iSeries, with a progress monitor.
 String verify(boolean bPrompt)
          Verify the member for syntactic and semantic errors
static String verify(IFile iFile, String sourceType, boolean bPrompt)
          Verify an IFile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

ISeriesEditableSrcPhysicalFileMember

public ISeriesEditableSrcPhysicalFileMember(ISeriesMember member)
                                     throws com.ibm.etools.systems.core.messages.SystemMessageException
Constructor


ISeriesEditableSrcPhysicalFileMember

public ISeriesEditableSrcPhysicalFileMember(ISeriesMember member,
                                            boolean readonly)
                                     throws com.ibm.etools.systems.core.messages.SystemMessageException
Constructor

Parameters:
member - the ISeriesMember to be opened in the editor.
readonly - Download the file as readonly
Method Detail

setMember

public void setMember(ISeriesMember member)
               throws com.ibm.etools.systems.core.messages.SystemMessageException
Set the remote member

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getMember

public ISeriesMember getMember()
Return the ISeriesMember object representing this member

Returns:
the embedded member

getRemotePath

public String getRemotePath()
Get the remote path. This is the IFS-style name, as in "/QSYS.LIB/lib.LIB/file.FILE/mbr.MBR"


getEditor

public com.ibm.etools.systems.editor.SystemTextEditor getEditor()
Get the editor

Returns:
the editor

connect

public void connect()
             throws com.ibm.etools.systems.core.messages.SystemMessageException
Connects and resets parameters, if not connected. Uses active shell.

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

connect

public void connect(Shell shell)
             throws com.ibm.etools.systems.core.messages.SystemMessageException
Connects and resets parameters, if not connected. Uses passed-in shell.

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

isConnected

public boolean isConnected()
Returns if connection is connected


closeStream

public void closeStream()
                 throws Exception
Close the member

Throws:
Exception

openStream

public boolean openStream()
                   throws Exception
Open member for write.

Returns:
true if all went well, false if not able to connect
Throws:
Exception

setTrace

public void setTrace(boolean tracing)
Turn on tracing statements for debug purposes.


download

public boolean download(Shell shell)
                 throws Exception
Download the member.

Specified by:
download in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
Throws:
Exception

download

public boolean download(Shell shell,
                        boolean force)
                 throws Exception
Download the member.

Parameters:
force - Force the member to be downloaded even if a local copy already exists with the same timestamp.
Throws:
Exception

download

public boolean download(Shell shell,
                        boolean force,
                        boolean silent)
                 throws Exception
Download the member.

Parameters:
force - force the member to be downloaded even if a local copy already exists with the same timestamp.
silent - if the member is locked, download the member in silent mode without asking the user.
Throws:
Exception

download

public boolean download(Shell shell,
                        boolean force,
                        boolean silent,
                        boolean doRefresh)
                 throws Exception
Download the member.

Parameters:
force - force the member to be downloaded even if a local copy already exists with the same timestamp.
silent - if the member is locked, download the member in silent mode without asking the user.
Throws:
Exception

download

public boolean download(IProgressMonitor monitor)
                 throws Exception
Download the member.

Specified by:
download in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
Throws:
Exception

download

public boolean download(IProgressMonitor monitor,
                        boolean force)
                 throws Exception
Download the member.

Parameters:
monitor - the progress monitor to show during the download. Can be null.
force - force a refresh of the RSE temp files project
Throws:
Exception

download

public boolean download(IProgressMonitor monitor,
                        boolean force,
                        boolean doRefresh)
                 throws Exception
Download the member.

Parameters:
monitor - the progress monitor to show during the download. Can be null.
force - force a refresh of the RSE temp files project
Throws:
Exception

setContents

public void setContents(Shell shell,
                        String[] contents,
                        boolean upload)
                 throws Exception
Set the contents of the member in its local copy, and optionally upload it to the host

Throws:
Exception

upload

public void upload(Shell shell)
            throws Exception
Upload the member to the iSeries, with a progress monitor.

Throws:
Exception

upload

public void upload(IProgressMonitor monitor)
            throws Exception
Upload the member to the iSeries. If you desire a progress monitor, see update(Shell) This is assumed to be called by the editor, hence the member is locked after this call. If you don't desire this, be sure to call closeStream()!

Throws:
Exception

getLocalResource

public IFile getLocalResource()
Remote members that have been edited before are cached locally as an IFile in our own RSE tempfiles project. To access this local IFile, call this method. Note, if this member has not been edited before, then this IFile will not physically exist yet. If you need it to exist, call getAndCreateLocalResource.

Specified by:
getLocalResource in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

getAndCreateLocalResource

public IFile getAndCreateLocalResource()
Remote members that have been edited before are cached locally as an IFile in our own RSE tempfiles project. To access this local IFile, call this method. If this member has not been edited before, then this IFile will not physically exist yet. In this case, this method call will create it. This is useful when creating a new member that you want to populate and then save. Call this method to create the local cache, the call upload.


delete

public void delete()
Delete the local resource


getDownloadPath

public String getDownloadPath()
Gets the download path


getOSPath

protected String getOSPath(String path)

getDownloadPath

public String getDownloadPath(ISeriesMember rmember)
Gets the download path


isPassiveCommunicationsListener

public boolean isPassiveCommunicationsListener()
Specified by:
isPassiveCommunicationsListener in interface com.ibm.etools.systems.subsystems.ICommunicationsListener
See Also:
ICommunicationsListener.isPassiveCommunicationsListener()

communicationsStateChange

public void communicationsStateChange(com.ibm.etools.systems.subsystems.CommunicationsEvent event)
Specified by:
communicationsStateChange in interface com.ibm.etools.systems.subsystems.ICommunicationsListener
See Also:
ICommunicationsListener#communicationsStateChanged(CommunicationsEvent)

checkOpenInEditor

public int checkOpenInEditor()
                      throws CoreException
Is the local file open in an editor

Specified by:
checkOpenInEditor in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
Throws:
CoreException

open

public void open(Shell shell)
Open member in editor for read / write. This is the same as calling open(shell, false);

Specified by:
open in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

open

public void open(Shell shell,
                 boolean readOnly)
Open in editor in specified mode.

Specified by:
open in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

queryLocks

public com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock queryLocks()
                                                                        throws com.ibm.etools.systems.core.messages.SystemMessageException
Query whether member is locked on the server. By locked, we mean locked so that we can not obtain write access to the member

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

queryLocks

public com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock queryLocks(ISeriesMember amember)
                                                                        throws com.ibm.etools.systems.core.messages.SystemMessageException
Query whether member is locked on the server. By locked, we mean locked so that we can not obtain write access to the member

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

setLocalResourceProperties

public void setLocalResourceProperties()
                                throws CoreException,
                                       com.ibm.etools.systems.core.messages.SystemMessageException,
                                       Exception
Set local resource properties

Specified by:
setLocalResourceProperties in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
Throws:
CoreException
com.ibm.etools.systems.core.messages.SystemMessageException
Exception

setLocalResourceProperties

public void setLocalResourceProperties(boolean setCharset)
                                throws CoreException,
                                       com.ibm.etools.systems.core.messages.SystemMessageException,
                                       Exception
Set local resource properties Normally this method is not called directly, use setLocalResourceProperties() instead which calls this one with a parameter of true. Use this method when you know that you do not need to set the character set of the IFile

Parameters:
setCharset - true if you want to call file.setCharset() which causes a resource change event
Throws:
CoreException
com.ibm.etools.systems.core.messages.SystemMessageException
Exception

addAsListener

public void addAsListener()
Register as listener for various events

Specified by:
addAsListener in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

openEditor

public void openEditor()
                throws PartInitException
Open the editor

Specified by:
openEditor in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject
Throws:
PartInitException

getEditorTitle

public String getEditorTitle()
Get editor title


setEditor

public void setEditor(IEditorPart editor)
Set the editor

Specified by:
setEditor in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

setEditorAsReadOnly

public void setEditorAsReadOnly()
Set editor to read only


setReadOnly

public void setReadOnly(boolean flag)
Specified by:
setReadOnly in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

isReadOnly

public boolean isReadOnly()
is the editor readonly?

Specified by:
isReadOnly in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

refresh

public void refresh()
Refresh the remote edit project.


updateDirtyIndicator

public void updateDirtyIndicator()
Update the dirty indicator

Specified by:
updateDirtyIndicator in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

partActivated

public void partActivated(IWorkbenchPart part)
Specified by:
partActivated in interface IPartListener
See Also:
IPartListener.partActivated(IWorkbenchPart)

partBroughtToTop

public void partBroughtToTop(IWorkbenchPart part)
Specified by:
partBroughtToTop in interface IPartListener
See Also:
IPartListener.partBroughtToTop(IWorkbenchPart)

getRemoteMemberTimestamp

public static long getRemoteMemberTimestamp(ISeriesMember remoteMember)

partClosed

public void partClosed(IWorkbenchPart part)
Specified by:
partClosed in interface IPartListener
See Also:
IPartListener.partClosed(IWorkbenchPart)

partDeactivated

public void partDeactivated(IWorkbenchPart part)
Specified by:
partDeactivated in interface IPartListener
See Also:
IPartListener.partDeactivated(IWorkbenchPart)

partOpened

public void partOpened(IWorkbenchPart part)
Specified by:
partOpened in interface IPartListener
See Also:
IPartListener.partOpened(IWorkbenchPart)

getVerifierForSourceType

public Verifier getVerifierForSourceType(String sourceType,
                                         IFile iFile)
get the verifier for a source type and IFile


getVerifierForSourceTypeStatic

public static Verifier getVerifierForSourceTypeStatic(String sourceType,
                                                      IFile iFile)
get the verifier for a source type and IFile


isVerifiableSourceType

public static boolean isVerifiableSourceType(String sourceType)
check if there is a verifier, based on source type


isVerifiableWithPromptSourceType

public static boolean isVerifiableWithPromptSourceType(String sourceType)
check if there is a verifier that prompts for options, based on source type


isILERRPGSourceType

public static boolean isILERRPGSourceType(String sourceType)
check if there is source type is of type ILE RPG


isCOBOLSourceType

public static boolean isCOBOLSourceType(String sourceType)
check if there is source type is of type COBOL


isDDSSourceType

public static boolean isDDSSourceType(String sourceType)
check if there is source type is of type DDS


verify

public String verify(boolean bPrompt)
Verify the member for syntactic and semantic errors


verify

public static String verify(IFile iFile,
                            String sourceType,
                            boolean bPrompt)
Verify an IFile

Parameters:
iFile -
bPrompt -

doImmediateSaveAndUpload

public boolean doImmediateSaveAndUpload()
Saves the local file and uploads it to the host immediately, rather than, in response to a resource change event.

Specified by:
doImmediateSaveAndUpload in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

saveAs

public boolean saveAs(ISeriesMember newMember,
                      IProgressMonitor progressMonitor)
Save as to a remote location


canWrite

public boolean canWrite()

isDirty

public boolean isDirty()
Specified by:
isDirty in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

getRemoteObject

public IAdaptable getRemoteObject()
Returns the remote object that is editable

Specified by:
getRemoteObject in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

getEditorPart

public IEditorPart getEditorPart()
Returns the open IEditorPart for this remote object if there is one.

Specified by:
getEditorPart in interface com.ibm.etools.systems.core.resources.ISystemEditableRemoteObject

openIsCanceled

public boolean openIsCanceled()
Return if the open is canceled or not


getFullName

public String getFullName()
Return the fully qualified member name: library/object(member)


getISeriesConnection

public ISeriesConnection getISeriesConnection()
Returns the ISeriesConnection from which this object originated.


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.