Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.services.qsys.objects
Class QSYSHostServiceProgram

java.lang.Object
  extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
      extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBrief
          extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBasic
              extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectExhaustive
                  extended by com.ibm.etools.iseries.services.qsys.objects.QSYSHostObject
                      extended by com.ibm.etools.iseries.services.qsys.objects.QSYSHostServiceProgram
All Implemented Interfaces:
IISeriesHostObjectBasic, IISeriesHostObjectBrief, IISeriesHostObjectExhaustive, IISeriesHostObjectNameOnly, IQSYSObject, IQSYSProgramBase, IQSYSResource, IQSYSServiceProgram

public class QSYSHostServiceProgram
extends QSYSHostObject
implements IQSYSServiceProgram

Class representing an IBM i service program object


Field Summary
static String copyright
           
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectExhaustive
activeDate, allowChgByPgm, apar, auditingValue, auxPool, changedByPgm, compiler, compressionStatus, Copyright, daysUsed, domain, lastUsedDate, level, licPgm, overflowedASP, owner, primaryGroup, profile, ptf, resetDate, restoredDate, saveCmd, saveDate, saveDevice, saveFile, saveLabel, saveLib, saveSeqNbr, saveSize, saveVolumeId, srcDate, srcFile, srcLib, srcMbr, storage, systemCreated, systemLevel, usageInfoUpdated, userChanged, userDefinedAttribute
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBasic
changeDate, createDate, size
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBrief
file, subtype, type
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
library, name
 
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
 
Constructor Summary
QSYSHostServiceProgram()
           
 
Method Summary
 void clearCachedAttributes()
          Clear cached attributes and force the next query to refresh attributes from the remote system.
 Object[] getModuleList()
          Retrieve a list of modules for this program object.
 boolean isDebuggable()
          Check if this program is debuggable.
 boolean isOPMProgram()
          Check if the program is and OPM or ILE program.
 
Methods inherited from class com.ibm.etools.iseries.services.qsys.objects.QSYSHostObject
clearCachedProperties, exists, getParent
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectExhaustive
getAllowChangeByProgram, getAPAR, getAuxiliaryStoragePool, getChangedByProgram, getCompiler, getCompressionStatus, getCreatorUserProfile, getDaysUsedCount, getDomain, getLastUsedDate, getLicensedProgram, getObjectAuditingValue, getObjectLevel, getObjectOverflowedASP, getOwner, getPrimaryGroup, getPTF, getResetDate, getRestoredDate, getSaveActiveDate, getSaveCommand, getSavedDate, getSaveDevice, getSaveFileName, getSaveLabel, getSaveLibrary, getSaveSequenceNumber, getSaveSize, getSaveVolumeId, getSourceChangedDate, getSourceFile, getSourceLibrary, getSourceMember, getStorage, getSystemLevel, getSystemWhereCreated, getUsageInformationUpdated, getUserChanged, getUserDefinedAttribute, setAllowChangeByProgram, setAPAR, setAuxiliaryStoragePool, setChangedByProgram, setCompiler, setCompressionStatus, setCreatorUserProfile, setDaysUsedCount, setDomain, setLastUsedDate, setLicensedProgram, setObjectAuditingValue, setObjectLevel, setObjectOverflowedASP, setOwner, setPrimaryGroup, setPTF, setResetDate, setRestoredDate, setSaveActiveDate, setSaveCommand, setSavedDate, setSaveDevice, setSaveFileName, setSaveLabel, setSaveLibrary, setSaveSequenceNumber, setSaveSize, setSaveVolumeId, setSourceChangedDate, setSourceFile, setSourceLibrary, setSourceMember, setStorage, setSystemLevel, setSystemWhereCreated, setUsageInformationUpdated, setUserChanged, setUserDefinedAttribute, writeObjectInfo
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBasic
equals, getAbsoluteName, getDateCreated, getDateModified, getFullName, getSize, hashCode, setDateCreated, setDateModified, setSize
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBrief
getDescription, getFile, getInformationStatus, getSubType, getType, setDescription, setFile, setInformationStatus, setSubType, setType, toString
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
getLibrary, getName, setLibrary, setName
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.etools.iseries.services.qsys.api.IQSYSObject
clearCachedProperties
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive
getAllowChangeByProgram, getAPAR, getAuxiliaryStoragePool, getChangedByProgram, getCompiler, getCompressionStatus, getCreatorUserProfile, getDaysUsedCount, getDomain, getLastUsedDate, getLicensedProgram, getObjectAuditingValue, getObjectLevel, getObjectOverflowedASP, getOwner, getPrimaryGroup, getPTF, getResetDate, getRestoredDate, getSaveActiveDate, getSaveCommand, getSavedDate, getSaveDevice, getSaveFileName, getSaveLabel, getSaveLibrary, getSaveSequenceNumber, getSaveSize, getSaveVolumeId, getSourceChangedDate, getSourceFile, getSourceLibrary, getSourceMember, getStorage, getSystemLevel, getSystemWhereCreated, getUsageInformationUpdated, getUserChanged, getUserDefinedAttribute, setAllowChangeByProgram, setAPAR, setAuxiliaryStoragePool, setChangedByProgram, setCompiler, setCompressionStatus, setCreatorUserProfile, setDaysUsedCount, setDomain, setLastUsedDate, setLicensedProgram, setObjectAuditingValue, setObjectLevel, setObjectOverflowedASP, setOwner, setPrimaryGroup, setPTF, setResetDate, setRestoredDate, setSaveActiveDate, setSaveCommand, setSavedDate, setSaveDevice, setSaveFileName, setSaveLabel, setSaveLibrary, setSaveSequenceNumber, setSaveSize, setSaveVolumeId, setSourceChangedDate, setSourceFile, setSourceLibrary, setSourceMember, setStorage, setSystemLevel, setSystemWhereCreated, setUsageInformationUpdated, setUserChanged, setUserDefinedAttribute
 
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, writeObjectInfo
 
Methods inherited from interface com.ibm.etools.iseries.services.qsys.api.IQSYSResource
exists, getAbsoluteName, getDateCreated, getDateModified, getDescription, getFullName, getLibrary, getName, getParent, getSize, getSubType, getType, setDescription, setLibrary, setName, setSubType, setType
 

Field Detail

copyright

public static String copyright
Constructor Detail

QSYSHostServiceProgram

public QSYSHostServiceProgram()
Method Detail

isDebuggable

public boolean isDebuggable()
                     throws SystemMessageException
Check if this program is debuggable.

Specified by:
isDebuggable in interface IQSYSProgramBase
Throws:
SystemMessageException

isOPMProgram

public boolean isOPMProgram()
                     throws SystemMessageException
Check if the program is and OPM or ILE program.

Specified by:
isOPMProgram in interface IQSYSProgramBase
Throws:
SystemMessageException

getModuleList

public Object[] getModuleList()
                       throws SystemMessageException
Retrieve a list of modules for this program object. Each element in ths list is an instance of IISeriesHostModuleBasic. Calling this methods results in a comm call to the backend to retrieve the module list.

Specified by:
getModuleList in interface IQSYSProgramBase
Throws:
SystemMessageException

clearCachedAttributes

public void clearCachedAttributes()
Clear cached attributes and force the next query to refresh attributes from the remote system.

Specified by:
clearCachedAttributes in interface IQSYSProgramBase

Rational Developer for Power Systems Software
V7.6

Copyright © 2011 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.