iSeries Remote Systems
v6.0.1

com.ibm.etools.iseries.core.api
Class ISeriesMember

java.lang.Object
  extended bycom.ibm.etools.iseries.core.api.ISeriesDataElementWrapper
      extended bycom.ibm.etools.iseries.core.api.ISeriesHostObjectBriefWrapper
          extended bycom.ibm.etools.iseries.core.api.ISeriesHostObjectBasicWrapper
              extended bycom.ibm.etools.iseries.core.api.ISeriesMember
All Implemented Interfaces:
IAdaptable, IISeriesDataElementWrapper, com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic, com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief, com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly, com.ibm.etools.iseries.comm.interfaces.IISeriesMember, ISeriesDataStoreConstants

public class ISeriesMember
extends com.ibm.etools.iseries.core.api.ISeriesHostObjectBasicWrapper
implements IAdaptable, com.ibm.etools.iseries.comm.interfaces.IISeriesMember

This is a usable representation of an object on a remote iSeries object. It contains most of the attributes as retrieved from the system api for listing objects.

This object is instantiated from the DataElement object that is normally returned from a remote list request.

Note that the setXXX methods do not change the record on the host. Rather, their purpose is simply to capture the attribute internally, after reading it from an external source, say.

See the iSeries CL API QUSLOBJ for a full description of each attribute


Field Summary
protected  boolean bBasicPropertiesAvailable
           
protected  boolean bExhaustivePropertiesAvailable
           
protected  boolean bValue
           
protected  Calendar calendar
           
static String copyright
           
protected  char cValue
           
protected  Date date
           
protected  int day
           
protected  com.ibm.etools.systems.dstore.core.model.DataElement deProperties
           
protected  com.ibm.etools.systems.dstore.core.model.DataElement deProperty
           
protected  int hour
           
protected  int iValue
           
protected  long lValue
           
protected  int minute
           
protected  int month
           
protected  StringBuffer sbValue
           
protected  int second
           
protected  String sValue
           
protected  int year
           
 
Fields inherited from class com.ibm.etools.iseries.core.api.ISeriesDataElementWrapper
cacheFilter, cacheTimeStamp, dataelement, EXPIRE_TIME, lastException, lastRunMsg, lastRunMsgId, localCache
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic
Copyright
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
STATUS_DAMAGED, STATUS_LOCKED, STATUS_NOTAUTHORIZED, STATUS_OK, STATUS_PARTIALLYDAMAGED, STATUS_STRING_DAMAGED, STATUS_STRING_LOCKED, STATUS_STRING_NOTAUTHORIZED, STATUS_STRING_PARTIALLYDAMAGED
 
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, 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, MINER_VERSION, 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
ISeriesMember(com.ibm.etools.systems.dstore.core.model.DataElement dataelement)
          Constructor
 
Method Summary
 ISeriesEditableSrcPhysicalFileMember browse()
          Opens this member in the integrated LPEX editor, in browse mode, using the currently active shell.
 ISeriesEditableSrcPhysicalFileMember browse(Shell shell)
          Opens this member in the integrated LPEX editor, in browse mode, using a given shell.
static ISeriesEditableSrcPhysicalFileMember browse(Shell shell, ISeriesConnection connection, String libName, String fileName, String mbrName)
          Opens a given member member in the integrated LPEX editor, in browse mode.
 boolean canRead()
          Queries whether we have read access authority to the member
 boolean canWrite()
          Queries whether we have write access authority to the member
 void clearCachedProperties()
          Clear the properties (last modified, size, ...) cached in this instance.
 void compile(boolean prompt)
          Compile the member with the last used compile command for this member type
static ISeriesMember createTempMember(Shell shell, ISeriesConnection connection, String libName, String fileName, String mbrName, String[] contents)
          Create a temporary source member and populate it with the given contents.
 boolean download(IProgressMonitor monitor)
          Download the member.
 boolean download(IProgressMonitor monitor, boolean leaveVisual)
          Download the member.
 boolean download(IProgressMonitor monitor, boolean leaveVisual, boolean force)
          Download the member.
 boolean download(IProgressMonitor monitor, boolean leaveVisual, boolean force, boolean doRefresh)
          Download the member.
 boolean download(Shell shell)
          Download the member.
 boolean download(Shell shell, boolean leaveVisual)
          Download the member.
 boolean download(Shell shell, boolean leaveVisual, boolean force)
          Download the member.
 boolean download(Shell shell, boolean leaveVisual, boolean force, boolean silent)
          Download the member.
 boolean download(Shell shell, boolean leaveVisual, boolean force, boolean silent, boolean doRefresh)
          Download the member.
 boolean equals(Object obj)
          Test if two remote object instances refer to the exact same object
 boolean exists()
          Queries whether the member exists
 void get(String localPath)
          Downloads the member from the iSeries server.
 void get(String localPath, String encoding)
          Downloads the member from the iSeries server.
 String getAbsoluteName()
          Return the absolute object name: "library/object(member)"
 ISeriesEditableSrcPhysicalFileMember getAccess()
          Return an instance of ISeriesEditableSrcPhysicalFileMember for this member, which has a number of useful methods, beyond just opening the member for edit.
 Object getAdapter(Class adapterType)
          This is the method required by the IAdaptable interface.
 String getAttribute()
          Return the object's attribute.
 void getBasicProperties()
          Retrieve the basic properties for this object from the remote system
 IFile getCachedCopy()
          Return the cached copy of this ISeries member.
 Date getChangeDate()
          Returns the creation date for this member.
 com.ibm.etools.iseries.comm.interfaces.ISequentialFileReader getContentsLineByLine()
          Return the contents of the files once it is downloaded, one line at a time.
 com.ibm.etools.iseries.comm.interfaces.ISequentialFileReader getContentsLineByLine(boolean transientDownload, boolean bidiVisual)
          Return a reader to access the contents of the member line by line.
 Date getCreationDate()
          Returns the creation date for this member.
 Date getDateCreated()
           
 Date getDateModified()
           
 String getDescription()
           
 String getDownloadPath()
          retrieves the path being used for downloading
 String getFile()
           
 String getFullName()
          Return the fully qualified member name: library/object(member)
 char getInformationStatus()
           
 ISeriesFile getISeriesFile(Shell shell)
          Return the parent file.
 String getLibrary()
           
 String getLibraryName()
          From base class.
 IFile getLocalResource()
           
 com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock[] getLocks()
          Retrieve any locks for this member.
 void getMemberProperties()
          Retrieve properties for this member.
 String getName()
           
 int getNumberOfDeleted()
          Returns the number of records for this member.
 int getNumberOfRecords()
          Returns the number of records deleted
 String getRemotePath()
          Retrieves the remote path of the member on the iSeries
 Date getRestoreDate()
          Returns the creation date for this member.
 Date getSaveDate()
          Returns the creation date for this member.
 long getSize()
           
 int getSourceFileCCSID()
          This is a specialized method for retrieving the member's CCSID for editing.
 String getSourceType()
          Return the source type for this memeber
 String getSubType()
          Return the object's attribute.
 String getType()
          Return the object's type
 boolean isLocked()
          Check if the member has any locks on it.
 ISeriesEditableSrcPhysicalFileMember open()
          Opens this member in the integrated LPEX editor, using the currently active shell
 ISeriesEditableSrcPhysicalFileMember open(Shell shell)
          Opens this member in the integrated LPEX editor, using a given shell.
static ISeriesEditableSrcPhysicalFileMember open(Shell shell, ISeriesConnection connection, String libName, String fileName, String mbrName)
          Opens a given member member in the integrated LPEX editor.
 void put(String localPath)
          Uploads the member back to the iSeries server.
 void put(String localPath, String encoding)
          Uploads the member back to the iSeries server.
 void refresh()
          Refresh the remote edit project.
 void setDateCreated(Date date)
           
 void setDateModified(Date date)
           
 void setDescription(String text)
           
 void setFile(String file)
           
 void setInformationStatus(char status)
           
 void setISeriesFile(ISeriesFile parentFile)
          Set the parent ISeriesFile of this object, if we know it.
 void setLibrary(String name)
           
 void setName(String name)
           
 void setRemoveTrailingBlanks(boolean value)
          Sets whether or not trailing blanks should be removed upon download.
 void setSize(long size)
           
 void setSubType(String subtype)
           
 void setType(String type)
           
 String toString()
          Convert to a string.
 void upload(IProgressMonitor monitor)
          Upload the member to the iSeries.
 void upload(IProgressMonitor monitor, boolean isVisual, boolean insertSequenceNumbersIfRequired)
          Upload the member to the iSeries.
 void upload(Shell shell)
          Upload the member to the iSeries, with a progress monitor.
 void upload(Shell shell, boolean isVisual, boolean insertSequenceNumbersIfRequired)
          Upload the member to the iSeries, with a progress monitor.
 void writeObjectInfo(PrintWriter writer)
          For debugging purposes
 
Methods inherited from class com.ibm.etools.iseries.core.api.ISeriesDataElementWrapper
checkIsConnected, extractProperty, extractPropertyAsBoolean, extractPropertyAsByte, extractPropertyAsChar, extractPropertyAsInt, getCommandSubSystem, getDataElement, getDataStore, getFileSubSystem, getISeriesConnection, getLastException, getLastRunMessage, getLocalCache, getPropertiesNode, runCommand, setLastException, setLocalCache
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
getDescription, getFile, getInformationStatus, getSubType, getType, setDescription, setFile, setInformationStatus, setSubType, setType
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
getLibrary, getName, setLibrary, setName, toString
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values

bValue

protected boolean bValue

sValue

protected String sValue

iValue

protected int iValue

lValue

protected long lValue

cValue

protected char cValue

sbValue

protected StringBuffer sbValue

date

protected Date date

deProperties

protected com.ibm.etools.systems.dstore.core.model.DataElement deProperties

deProperty

protected com.ibm.etools.systems.dstore.core.model.DataElement deProperty

year

protected int year

month

protected int month

day

protected int day

hour

protected int hour

minute

protected int minute

second

protected int second

calendar

protected Calendar calendar

bBasicPropertiesAvailable

protected boolean bBasicPropertiesAvailable

bExhaustivePropertiesAvailable

protected boolean bExhaustivePropertiesAvailable
Constructor Detail

ISeriesMember

public ISeriesMember(com.ibm.etools.systems.dstore.core.model.DataElement dataelement)
Constructor

Method Detail

getLibraryName

public String getLibraryName()
From base class.

Return the library containing this remote QSYS file system object

Specified by:
getLibraryName in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Specified by:
getLibraryName in class ISeriesDataElementWrapper

getAdapter

public Object getAdapter(Class adapterType)
Description copied from class: ISeriesDataElementWrapper
This is the method required by the IAdaptable interface. Given an adapter class type, return an object castable to the type, or null if this is not possible.

By default this defers to the getAdapter method of the contained DataElement

Specified by:
getAdapter in interface IAdaptable
Overrides:
getAdapter in class ISeriesDataElementWrapper
See Also:
IAdaptable.getAdapter(Class)

exists

public boolean exists()
               throws com.ibm.etools.systems.core.messages.SystemMessageException
Queries whether the member exists

Specified by:
exists in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Returns:
true if member exists on the server, false otherwise
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getSourceFileCCSID

public int getSourceFileCCSID()
                       throws com.ibm.etools.systems.core.messages.SystemMessageException
This is a specialized method for retrieving the member's CCSID for editing. It has two primary purposes: 1. Be fast. 2. Use a specific algorithm for determining the CCSID. First the source file's CCSID is checked. If this is 65535 then the job's CCSID is used. If this is 65535 then the job's default CCSID is used (this we are told will never be 65535.)

Specified by:
getSourceFileCCSID in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

canWrite

public boolean canWrite()
                 throws com.ibm.etools.systems.core.messages.SystemMessageException
Queries whether we have write access authority to the member

Returns:
true if user has write access to the member, false otherwise
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

canRead

public boolean canRead()
                throws com.ibm.etools.systems.core.messages.SystemMessageException
Queries whether we have read access authority to the member

Specified by:
canRead in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Returns:
true if user has read access to the member, false otherwise
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

isLocked

public boolean isLocked()
                 throws com.ibm.etools.systems.core.messages.SystemMessageException
Check if the member has any locks on it. For more specific information about the locks call getLocks();

Specified by:
isLocked in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getLocks

public com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectLock[] getLocks()
                                                                        throws com.ibm.etools.systems.core.messages.SystemMessageException
Retrieve any locks for this member.

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

getFullName

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

Specified by:
getFullName in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember

getAbsoluteName

public String getAbsoluteName()
Return the absolute object name: "library/object(member)"

Specified by:
getAbsoluteName in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Specified by:
getAbsoluteName in class ISeriesDataElementWrapper

getSourceType

public String getSourceType()
Return the source type for this memeber

Specified by:
getSourceType in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Returns:
The string representation of the source type for this file.

getISeriesFile

public ISeriesFile getISeriesFile(Shell shell)
Return the parent file. This may require a trip to the host when first called!


setISeriesFile

public void setISeriesFile(ISeriesFile parentFile)
Set the parent ISeriesFile of this object, if we know it. This makes the call to getISeriesFile() instantaneous.


getMemberProperties

public void getMemberProperties()
                         throws com.ibm.etools.systems.core.messages.SystemMessageException
Retrieve properties for this member. The properties in the ISeriesObject superclass (and other superclasses) are generic OS/400 object properites. This call retrieves the Member specific properties.

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

getCreationDate

public Date getCreationDate()
                     throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns the creation date for this member.

Returns:
Date or null if not available
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getChangeDate

public Date getChangeDate()
                   throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns the creation date for this member.

Returns:
Date or null if not available
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getSaveDate

public Date getSaveDate()
                 throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns the creation date for this member.

Returns:
Date or null if not available
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getRestoreDate

public Date getRestoreDate()
                    throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns the creation date for this member.

Returns:
Date or null if not available
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getNumberOfDeleted

public int getNumberOfDeleted()
                       throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns the number of records for this member.

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

getNumberOfRecords

public int getNumberOfRecords()
                       throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns the number of records deleted

Specified by:
getNumberOfRecords in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Returns:
int
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

get

public void get(String localPath)
         throws ISeriesEncapsulatedReturnCodeException,
                ISeriesEncapsulatedException,
                com.ibm.etools.systems.core.messages.SystemMessageException
Downloads the member from the iSeries server. The member is stored in UTF-8 encoding on the client.

Parameters:
localPath - the local path where the member will be stored. This must be an absolute path.
Throws:
ISeriesEncapsulatedReturnCodeException
ISeriesEncapsulatedException
com.ibm.etools.systems.core.messages.SystemMessageException

get

public void get(String localPath,
                String encoding)
         throws ISeriesEncapsulatedReturnCodeException,
                ISeriesEncapsulatedException,
                com.ibm.etools.systems.core.messages.SystemMessageException
Downloads the member from the iSeries server. The member is stored in the given encoding on the client.

Parameters:
localPath - the local path where the member will be stored. This must be an absolute path.
encoding - the encoding.
Throws:
ISeriesEncapsulatedReturnCodeException
ISeriesEncapsulatedException
com.ibm.etools.systems.core.messages.SystemMessageException

getCachedCopy

public IFile getCachedCopy()
                    throws com.ibm.etools.systems.core.messages.SystemMessageException
Return the cached copy of this ISeries member. The returned IFile must be used for read-only purposes since no locks are acquired on the remote member.

Returns:
IFile The cached copy of this member if it exists AND it is upto date. null is returned if a local cached copy of this member is not available or the local cached copy is not upto date (last modified timestamp comparison.)
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

put

public void put(String localPath)
         throws ISeriesEncapsulatedReturnCodeException,
                ISeriesEncapsulatedException,
                com.ibm.etools.systems.core.messages.SystemMessageException
Uploads the member back to the iSeries server. Assumes the member is stored in UTF-8 encoding on the client.

Parameters:
localPath - the local path where the member is stored. This must be an absolute path.
Throws:
ISeriesEncapsulatedReturnCodeException
ISeriesEncapsulatedException
com.ibm.etools.systems.core.messages.SystemMessageException

put

public void put(String localPath,
                String encoding)
         throws ISeriesEncapsulatedReturnCodeException,
                ISeriesEncapsulatedException,
                com.ibm.etools.systems.core.messages.SystemMessageException
Uploads the member back to the iSeries server. Assumes the member is stored in the given encoding on the client.

Parameters:
localPath - the local path where the member is stored. This must be an absolute path.
encoding - the encoding.
Throws:
ISeriesEncapsulatedReturnCodeException
ISeriesEncapsulatedException
com.ibm.etools.systems.core.messages.SystemMessageException

getAccess

public ISeriesEditableSrcPhysicalFileMember getAccess()
                                               throws com.ibm.etools.systems.core.messages.SystemMessageException
Return an instance of ISeriesEditableSrcPhysicalFileMember for this member, which has a number of useful methods, beyond just opening the member for edit. For example, you can get to the contents of the member by asking for its IFile handle (which will download it if and only if necessary).

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

open

public ISeriesEditableSrcPhysicalFileMember open()
                                          throws com.ibm.etools.systems.core.messages.SystemMessageException
Opens this member in the integrated LPEX editor, using the currently active shell

Returns:
the handle of the member for editing. It is opened in the editor
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

browse

public ISeriesEditableSrcPhysicalFileMember browse()
                                            throws com.ibm.etools.systems.core.messages.SystemMessageException
Opens this member in the integrated LPEX editor, in browse mode, using the currently active shell.

Returns:
the handle of the member for editing. It is opened in the editor
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

open

public ISeriesEditableSrcPhysicalFileMember open(Shell shell)
                                          throws com.ibm.etools.systems.core.messages.SystemMessageException
Opens this member in the integrated LPEX editor, using a given shell. Shell can be null, in which case the currently active workbench shell is used.

Returns:
the handle of the member for editing. It is opened in the editor
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

browse

public ISeriesEditableSrcPhysicalFileMember browse(Shell shell)
                                            throws com.ibm.etools.systems.core.messages.SystemMessageException
Opens this member in the integrated LPEX editor, in browse mode, using a given shell. Shell can be null, in which case the currently active workbench shell is used.

Returns:
the handle of the member for editing. It is opened in the editor
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

open

public static ISeriesEditableSrcPhysicalFileMember open(Shell shell,
                                                        ISeriesConnection connection,
                                                        String libName,
                                                        String fileName,
                                                        String mbrName)
                                                 throws com.ibm.etools.systems.core.messages.SystemMessageException
Opens a given member member in the integrated LPEX editor. Static version.

Parameters:
shell - The shell needed to host the logon prompt dialog, if needed. Can be null, in which case the currently active workbench shell is used.
connection - An ISeriesConnection object. If you only have a SystemConnection object, then use the static getConnection(SystemConnection) method in ISeriesConnection
libName - Library containing the file containing the member
fileName - File containing the member
mbrName - Name of the member to open
Returns:
null if the member doesn't exist, else an object representing the local editable copy of it.
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

browse

public static ISeriesEditableSrcPhysicalFileMember browse(Shell shell,
                                                          ISeriesConnection connection,
                                                          String libName,
                                                          String fileName,
                                                          String mbrName)
                                                   throws com.ibm.etools.systems.core.messages.SystemMessageException
Opens a given member member in the integrated LPEX editor, in browse mode. Static version.

Parameters:
shell - The shell needed to host the logon prompt dialog, if needed. Can be null, in which case the currently active workbench shell is used.
connection - An ISeriesConnection object. If you only have a SystemConnection object, then use the static getConnection(SystemConnection) method in ISeriesConnection
libName - Library containing the file containing the member
fileName - File containing the member
mbrName - Name of the member to open
Returns:
null if the member doesn't exist, else an object representing the local editable copy of it.
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

createTempMember

public static ISeriesMember createTempMember(Shell shell,
                                             ISeriesConnection connection,
                                             String libName,
                                             String fileName,
                                             String mbrName,
                                             String[] contents)
                                      throws com.ibm.etools.systems.core.messages.SystemMessageException
Create a temporary source member and populate it with the given contents. The rules are:

Returns:
null if library doesn't exist, or error occurs creating file or member
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException - if an error occurs while performing any operation. Wraps the remote system message

compile

public void compile(boolean prompt)
Compile the member with the last used compile command for this member type


getContentsLineByLine

public com.ibm.etools.iseries.comm.interfaces.ISequentialFileReader getContentsLineByLine()
                                                                                   throws Exception
Return the contents of the files once it is downloaded, one line at a time. Return null if there was a problem downloading the member or opening the local file

Specified by:
getContentsLineByLine in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Throws:
Exception
See Also:
IISeriesMember.getContentsLineByLine()

getContentsLineByLine

public com.ibm.etools.iseries.comm.interfaces.ISequentialFileReader getContentsLineByLine(boolean transientDownload,
                                                                                          boolean bidiVisual)
                                                                                   throws Exception
Return a reader to access the contents of the member line by line.

Specified by:
getContentsLineByLine in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Parameters:
transientDownload - Specifies if the temporary copy of the member downloaded for the reader is deleted after the reader completes.
bidiVisual - If the file contains BIDI text then the text is returned in visual format. If bidiVisual is true then transientDownload is ignored and assumed to be true. This is because the local copy cannot be added to the workspace if it is BIDI and in visual ordering. Note: transientDownload detrmines whether caching occurs, irrespective of the sense of bidiVisual. See ISeriesSrcPhysicalFileMemberTransientReader() for transientDownload usag there.
Throws:
Exception

download

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

Throws:
Exception
Since:
6.0.1

download

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

Throws:
Exception
Since:
6.0.1

download

public boolean download(IProgressMonitor monitor,
                        boolean leaveVisual,
                        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
Since:
6.0.1

download

public boolean download(IProgressMonitor monitor,
                        boolean leaveVisual,
                        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
Since:
6.0.1

download

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

Throws:
Exception
Since:
6.0.1

download

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

Parameters:
leaveVisual - true if the member should be left in visual state
Throws:
Exception
Since:
6.0.1

download

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

Parameters:
leaveVisual - true if the member should be left in visual state
force - Force the member to be downloaded even if a local copy already exists with the same timestamp.
Throws:
Exception
Since:
6.0.1

download

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

Parameters:
leaveVisual - true if the member should be left in visual state
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
Since:
6.0.1

download

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

Parameters:
leaveVisual - true if the member should be left in visual state
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.
doRefresh -
Throws:
Exception
Since:
6.0.1

getDownloadPath

public String getDownloadPath()
retrieves the path being used for downloading

Returns:
the filename where the member will be downloaded
Since:
6.0.1

upload

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

Throws:
Exception
Since:
6.0.1

upload

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

Parameters:
isVisual - true if the member is already in visual state
insertSequenceNumbersIfRequired - true if you want sequence numbers inserted.
Throws:
Exception
Since:
6.0.1

upload

public void upload(IProgressMonitor monitor)
            throws Exception
Upload the member to the iSeries. If you desire a progress monitor, see update(Shell)

Throws:
Exception
Since:
6.0.1

upload

public void upload(IProgressMonitor monitor,
                   boolean isVisual,
                   boolean insertSequenceNumbersIfRequired)
            throws Exception
Upload the member to the iSeries. If you desire a progress monitor, see update(Shell)

Parameters:
isVisual - true if the member is already in visual state
insertSequenceNumbersIfRequired - true if you want sequence numbers inserted.
Throws:
Exception
Since:
6.0.1

getRemotePath

public String getRemotePath()
Retrieves the remote path of the member on the iSeries

Returns:
The remote path
Since:
6.0.1 //59962

refresh

public void refresh()
Refresh the remote edit project.

Since:
6.0.1 //59962

getLocalResource

public IFile getLocalResource()

setRemoveTrailingBlanks

public void setRemoveTrailingBlanks(boolean value)
Sets whether or not trailing blanks should be removed upon download.

Specified by:
setRemoveTrailingBlanks in interface com.ibm.etools.iseries.comm.interfaces.IISeriesMember
Parameters:
value - True if the trailing blanks should be stripped, false otherwise
Since:
6.0.1

getBasicProperties

public void getBasicProperties()
Retrieve the basic properties for this object from the remote system


clearCachedProperties

public void clearCachedProperties()
Clear the properties (last modified, size, ...) cached in this instance.


setDateModified

public void setDateModified(Date date)
Specified by:
setDateModified in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic

setDateCreated

public void setDateCreated(Date date)
Specified by:
setDateCreated in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic

setSize

public void setSize(long size)
Specified by:
setSize in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic

getDateCreated

public Date getDateCreated()
Specified by:
getDateCreated in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic

getDateModified

public Date getDateModified()
Specified by:
getDateModified in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic

getSize

public long getSize()
Specified by:
getSize in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic

writeObjectInfo

public void writeObjectInfo(PrintWriter writer)
For debugging purposes

Specified by:
writeObjectInfo in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
See Also:
IISeriesHostObjectNameOnly#writeObjectInfo(PrintWriter)

setFile

public void setFile(String file)
Specified by:
setFile in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
See Also:
IISeriesHostObjectBrief.setFile(String)

setType

public void setType(String type)
Specified by:
setType in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
See Also:
IISeriesHostObjectBrief.setType(String)

setSubType

public void setSubType(String subtype)
Specified by:
setSubType in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
See Also:
IISeriesHostObjectBrief.setSubType(String)

setInformationStatus

public void setInformationStatus(char status)
Specified by:
setInformationStatus in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
See Also:
IISeriesHostObjectBrief.setInformationStatus(char)

setDescription

public void setDescription(String text)
Specified by:
setDescription in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
See Also:
IISeriesHostObjectBrief.setDescription(String)

setName

public void setName(String name)
Specified by:
setName in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
See Also:
IISeriesHostObjectNameOnly#setName(String)

setLibrary

public void setLibrary(String name)
Specified by:
setLibrary in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
See Also:
IISeriesHostObjectNameOnly#setLibrary(String)

getName

public String getName()
Specified by:
getName in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
See Also:
IISeriesHostObjectNameOnly#getName()

getLibrary

public String getLibrary()
Specified by:
getLibrary in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
See Also:
IISeriesHostObjectNameOnly#getLibrary()

getFile

public String getFile()
Specified by:
getFile in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
See Also:
IISeriesHostObjectBrief.getFile()

getType

public String getType()
Return the object's type

Specified by:
getType in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
See Also:
IISeriesHostObjectBrief.getType()

getSubType

public String getSubType()
Return the object's attribute.

Specified by:
getSubType in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
See Also:
IISeriesHostObjectBrief.getSubType()

getAttribute

public String getAttribute()
Return the object's attribute. Same as ISeriesHostObjectBriefWrapper.getType()


getDescription

public String getDescription()
Specified by:
getDescription in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
See Also:
IISeriesHostObjectBrief.getDescription()

getInformationStatus

public char getInformationStatus()
Specified by:
getInformationStatus in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
See Also:
IISeriesHostObjectBrief.getInformationStatus()

toString

public String toString()
Convert to a string. Maps to getName()

Specified by:
toString in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly

equals

public boolean equals(Object obj)
Test if two remote object instances refer to the exact same object

Returns:
true if the hostname and fully qualified name for each object match
See Also:
Object.equals(Object)

iSeries Remote Systems
v6.0.1

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.