iSeries Remote Systems
v6.0.1

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

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.ISeriesHostObjectExhaustiveWrapper
                  extended bycom.ibm.etools.iseries.core.api.ISeriesObject
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.IISeriesHostObjectExhaustive, com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly, ISeriesDataStoreConstants
Direct Known Subclasses:
ISeriesAbstractProgramObject, ISeriesFile

public class ISeriesObject
extends com.ibm.etools.iseries.core.api.ISeriesHostObjectExhaustiveWrapper
implements IAdaptable

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.IISeriesHostObjectExhaustive
AUDITING_ALL, AUDITING_CHANGE, AUDITING_NONE, AUDITING_USRPRF, COMPRESSION_COMPRESSED, COMPRESSION_NOTCOMPRESSABLE, COMPRESSION_NOTCOMPRESSED, COMPRESSION_SAVEDFREED, COMPRESSION_TEMPORARILYCOMPRESSED, Copyright, DOMAIN_SYSTEM, DOMAIN_USER, STORAGE_FREE, STORAGE_KEEP
 
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
ISeriesObject(com.ibm.etools.systems.dstore.core.model.DataElement dataelement)
          Constructor
 
Method Summary
 void clearCachedProperties()
          Clear the properties (last modified, size, ...) cached in this instance.
 boolean equals(Object obj)
          Test if two remote object instances refer to the exact same object
 String getAbsoluteName()
          Return the absolute object name: library/object OBJTYPE(type)
 Object getAdapter(Class adapterType)
          This is the method required by the IAdaptable interface.
 boolean getAllowChangeByProgram()
           
 String getAPAR()
           
 String getAttribute()
          Return the object's attribute.
 int getAuxiliaryStoragePool()
           
 void getBasicProperties()
          Retrieve the basic properties for this object from the remote system
 boolean getChangedByProgram()
           
 String getCompiler()
           
 char getCompressionStatus()
           
 String getCreatorUserProfile()
           
 Date getDateCreated()
           
 Date getDateModified()
           
 int getDaysUsedCount()
           
 String getDescription()
           
 String getDomain()
           
 String getFile()
           
 String getFullName()
          Return the fully qualified object name: library/object
 char getInformationStatus()
           
 ISeriesLibrary getISeriesLibrary(Shell shell)
          Return the parent library.
 Date getLastUsedDate()
           
 String getLibrary()
           
 String getLibraryName()
          From base class.
 String getLicensedProgram()
           
 String getName()
           
 String getObjectAuditingValue()
           
 String getObjectLevel()
           
 boolean getObjectOverflowedASP()
           
 String getOwner()
           
 String getPrimaryGroup()
           
 String getPTF()
           
 Date getResetDate()
           
 Date getRestoredDate()
           
 Date getSaveActiveDate()
           
 String getSaveCommand()
           
 Date getSavedDate()
           
 String getSaveDevice()
           
 String getSaveFileName()
           
 String getSaveLabel()
           
 String getSaveLibrary()
           
 int getSaveSequenceNumber()
           
 long getSaveSize()
           
 String getSaveVolumeId()
           
 long getSize()
           
 Date getSourceChangedDate()
           
 String getSourceFile()
           
 String getSourceLibrary()
           
 String getSourceMember()
           
 String getStorage()
           
 String getSubType()
          Return the object's attribute.
 String getSystemLevel()
           
 String getSystemWhereCreated()
           
 String getType()
          Return the object's type
 boolean getUsageInformationUpdated()
           
 boolean getUserChanged()
           
 String getUserDefinedAttribute()
           
 void setAllowChangeByProgram(boolean allowChgByPgm)
           
 void setAPAR(String apar)
           
 void setAuxiliaryStoragePool(int auxPool)
           
 void setChangedByProgram(boolean changedByPgm)
           
 void setCompiler(String compiler)
           
 void setCompressionStatus(char compressionStatus)
           
 void setCreatorUserProfile(String profile)
           
 void setDateCreated(Date date)
           
 void setDateModified(Date date)
           
 void setDaysUsedCount(int daysUsed)
           
 void setDescription(String text)
           
 void setDomain(String domain)
           
 void setFile(String file)
           
 void setInformationStatus(char status)
           
 void setISeriesLibrary(ISeriesLibrary parentLibrary)
          Set the parent ISeriesLibrary of this object, if we know it.
 void setLastUsedDate(Date lastUsedDate)
           
 void setLibrary(String name)
           
 void setLicensedProgram(String licPgm)
           
 void setName(String name)
           
 void setObjectAuditingValue(String auditingValue)
           
 void setObjectLevel(String level)
           
 void setObjectOverflowedASP(boolean overflowedASP)
           
 void setOwner(String owner)
           
 void setPrimaryGroup(String primaryGroup)
           
 void setPTF(String ptf)
           
 void setResetDate(Date resetDate)
           
 void setRestoredDate(Date restoredDate)
           
 void setSaveActiveDate(Date activeDate)
           
 void setSaveCommand(String saveCmd)
           
 void setSavedDate(Date saveDate)
           
 void setSaveDevice(String saveDevice)
           
 void setSaveFileName(String saveFile)
           
 void setSaveLabel(String saveLabel)
           
 void setSaveLibrary(String saveLibrary)
           
 void setSaveSequenceNumber(int saveSeqNbr)
           
 void setSaveSize(long saveSize)
           
 void setSaveVolumeId(String saveId)
           
 void setSize(long size)
           
 void setSourceChangedDate(Date srcDate)
           
 void setSourceFile(String srcFile)
           
 void setSourceLibrary(String srcLib)
           
 void setSourceMember(String srcMbr)
           
 void setStorage(String storage)
           
 void setSubType(String subtype)
           
 void setSystemLevel(String systemLevel)
           
 void setSystemWhereCreated(String systemCreated)
           
 void setType(String type)
           
 void setUsageInformationUpdated(boolean usageInfoUpdated)
           
 void setUserChanged(boolean userChanged)
           
 void setUserDefinedAttribute(String userAttribute)
           
 String toString()
          Convert to a string.
 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.IISeriesHostObjectBasic
getDateCreated, getDateModified, getSize, setDateCreated, setDateModified, setSize
 
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

ISeriesObject

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

Method Detail

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)

getLibraryName

public String getLibraryName()
From base class.

Return the library containing this remote QSYS file system object

Specified by:
getLibraryName in class ISeriesDataElementWrapper

getFullName

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


getAbsoluteName

public String getAbsoluteName()
Return the absolute object name: library/object OBJTYPE(type)

Specified by:
getAbsoluteName in class ISeriesDataElementWrapper

getISeriesLibrary

public ISeriesLibrary getISeriesLibrary(Shell shell)
Return the parent library. This may require a trip to the host when first called!


setISeriesLibrary

public void setISeriesLibrary(ISeriesLibrary parentLibrary)
Set the parent ISeriesLibrary of this object, if we know it. This makes the call to getISeriesLibrary() instantaneous.


getAuxiliaryStoragePool

public int getAuxiliaryStoragePool()
Specified by:
getAuxiliaryStoragePool in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getOwner

public String getOwner()
Specified by:
getOwner in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getDomain

public String getDomain()
Specified by:
getDomain in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSourceFile

public String getSourceFile()
Specified by:
getSourceFile in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSourceLibrary

public String getSourceLibrary()
Specified by:
getSourceLibrary in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSourceMember

public String getSourceMember()
Specified by:
getSourceMember in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSourceChangedDate

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

getSavedDate

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

getRestoredDate

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

getCreatorUserProfile

public String getCreatorUserProfile()
Specified by:
getCreatorUserProfile in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSystemWhereCreated

public String getSystemWhereCreated()
Specified by:
getSystemWhereCreated in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getResetDate

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

getSaveSize

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

getSaveSequenceNumber

public int getSaveSequenceNumber()
Specified by:
getSaveSequenceNumber in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getStorage

public String getStorage()
Specified by:
getStorage in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSaveCommand

public String getSaveCommand()
Specified by:
getSaveCommand in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSaveVolumeId

public String getSaveVolumeId()
Specified by:
getSaveVolumeId in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSaveDevice

public String getSaveDevice()
Specified by:
getSaveDevice in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSaveFileName

public String getSaveFileName()
Specified by:
getSaveFileName in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSaveLibrary

public String getSaveLibrary()
Specified by:
getSaveLibrary in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSaveLabel

public String getSaveLabel()
Specified by:
getSaveLabel in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSystemLevel

public String getSystemLevel()
Specified by:
getSystemLevel in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getCompiler

public String getCompiler()
Specified by:
getCompiler in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getObjectLevel

public String getObjectLevel()
Specified by:
getObjectLevel in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getUserChanged

public boolean getUserChanged()
Specified by:
getUserChanged in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getLicensedProgram

public String getLicensedProgram()
Specified by:
getLicensedProgram in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getPTF

public String getPTF()
Specified by:
getPTF in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getAPAR

public String getAPAR()
Specified by:
getAPAR in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getLastUsedDate

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

getUsageInformationUpdated

public boolean getUsageInformationUpdated()
Specified by:
getUsageInformationUpdated in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getDaysUsedCount

public int getDaysUsedCount()
Specified by:
getDaysUsedCount in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getCompressionStatus

public char getCompressionStatus()
Specified by:
getCompressionStatus in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getAllowChangeByProgram

public boolean getAllowChangeByProgram()
Specified by:
getAllowChangeByProgram in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getChangedByProgram

public boolean getChangedByProgram()
Specified by:
getChangedByProgram in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getUserDefinedAttribute

public String getUserDefinedAttribute()
Specified by:
getUserDefinedAttribute in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getObjectOverflowedASP

public boolean getObjectOverflowedASP()
Specified by:
getObjectOverflowedASP in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getSaveActiveDate

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

getObjectAuditingValue

public String getObjectAuditingValue()
Specified by:
getObjectAuditingValue in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getPrimaryGroup

public String getPrimaryGroup()
Specified by:
getPrimaryGroup in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

writeObjectInfo

public void writeObjectInfo(PrintWriter writer)
For debugging purposes

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

setAuxiliaryStoragePool

public void setAuxiliaryStoragePool(int auxPool)
Specified by:
setAuxiliaryStoragePool in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setOwner

public void setOwner(String owner)
Specified by:
setOwner in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setDomain

public void setDomain(String domain)
Specified by:
setDomain in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSourceFile

public void setSourceFile(String srcFile)
Specified by:
setSourceFile in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSourceLibrary

public void setSourceLibrary(String srcLib)
Specified by:
setSourceLibrary in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSourceMember

public void setSourceMember(String srcMbr)
Specified by:
setSourceMember in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSourceChangedDate

public void setSourceChangedDate(Date srcDate)
Specified by:
setSourceChangedDate in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSavedDate

public void setSavedDate(Date saveDate)
Specified by:
setSavedDate in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setRestoredDate

public void setRestoredDate(Date restoredDate)
Specified by:
setRestoredDate in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setCreatorUserProfile

public void setCreatorUserProfile(String profile)
Specified by:
setCreatorUserProfile in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSystemWhereCreated

public void setSystemWhereCreated(String systemCreated)
Specified by:
setSystemWhereCreated in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setResetDate

public void setResetDate(Date resetDate)
Specified by:
setResetDate in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSaveSize

public void setSaveSize(long saveSize)
Specified by:
setSaveSize in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSaveSequenceNumber

public void setSaveSequenceNumber(int saveSeqNbr)
Specified by:
setSaveSequenceNumber in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setStorage

public void setStorage(String storage)
Specified by:
setStorage in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSaveCommand

public void setSaveCommand(String saveCmd)
Specified by:
setSaveCommand in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSaveVolumeId

public void setSaveVolumeId(String saveId)
Specified by:
setSaveVolumeId in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSaveDevice

public void setSaveDevice(String saveDevice)
Specified by:
setSaveDevice in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSaveFileName

public void setSaveFileName(String saveFile)
Specified by:
setSaveFileName in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSaveLibrary

public void setSaveLibrary(String saveLibrary)
Specified by:
setSaveLibrary in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSaveLabel

public void setSaveLabel(String saveLabel)
Specified by:
setSaveLabel in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSystemLevel

public void setSystemLevel(String systemLevel)
Specified by:
setSystemLevel in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setCompiler

public void setCompiler(String compiler)
Specified by:
setCompiler in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setObjectLevel

public void setObjectLevel(String level)
Specified by:
setObjectLevel in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setUserChanged

public void setUserChanged(boolean userChanged)
Specified by:
setUserChanged in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setLicensedProgram

public void setLicensedProgram(String licPgm)
Specified by:
setLicensedProgram in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setPTF

public void setPTF(String ptf)
Specified by:
setPTF in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setAPAR

public void setAPAR(String apar)
Specified by:
setAPAR in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setLastUsedDate

public void setLastUsedDate(Date lastUsedDate)
Specified by:
setLastUsedDate in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setUsageInformationUpdated

public void setUsageInformationUpdated(boolean usageInfoUpdated)
Specified by:
setUsageInformationUpdated in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setDaysUsedCount

public void setDaysUsedCount(int daysUsed)
Specified by:
setDaysUsedCount in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setCompressionStatus

public void setCompressionStatus(char compressionStatus)
Specified by:
setCompressionStatus in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setAllowChangeByProgram

public void setAllowChangeByProgram(boolean allowChgByPgm)
Specified by:
setAllowChangeByProgram in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setChangedByProgram

public void setChangedByProgram(boolean changedByPgm)
Specified by:
setChangedByProgram in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setUserDefinedAttribute

public void setUserDefinedAttribute(String userAttribute)
Specified by:
setUserDefinedAttribute in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setObjectOverflowedASP

public void setObjectOverflowedASP(boolean overflowedASP)
Specified by:
setObjectOverflowedASP in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setSaveActiveDate

public void setSaveActiveDate(Date activeDate)
Specified by:
setSaveActiveDate in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setObjectAuditingValue

public void setObjectAuditingValue(String auditingValue)
Specified by:
setObjectAuditingValue in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

setPrimaryGroup

public void setPrimaryGroup(String primaryGroup)
Specified by:
setPrimaryGroup in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

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

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.