Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.subsystems.qsys.objects
Class QSYSRemoteObject

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.subsystems.qsys.objects.QSYSRemoteObject
All Implemented Interfaces:
IISeriesHostObjectBasic, IISeriesHostObjectBrief, IISeriesHostObjectExhaustive, IISeriesHostObjectNameOnly, IQSYSObject, IQSYSResource, IRemoteObjectContextProvider
Direct Known Subclasses:
QSYSRemoteBaseProgram, QSYSRemoteCommand, QSYSRemoteFile, QSYSRemoteLibrary, QSYSRemoteMessageFile, QSYSRemoteModule, QSYSRemoteProgramModule, QSYSRemoteSaveFile

public class QSYSRemoteObject
extends QSYSHostObject
implements IRemoteObjectContextProvider

Class representing an IBM i native (QSYS) object. This class is used by (and is knowledgeable of) RSE connections and subsystems. This class should not be directly referenced. All access should be done using the corresponding IQSYSObject and IRemoteObjectContextProvider interfaces. Brief properties are always retrieved. Exhaustive properties are only retrieved on first request.


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
QSYSRemoteObject()
           
 
Method Summary
 void clearCachedProperties()
          Clear any cached properties
 boolean equals(Object obj)
          Two QSYSHostObjects objects are equal if they have the same name and library name.
 boolean exists()
          This operation is not supported at the service layer.
 String getAbsoluteName()
          Get the absolute name (includes type) for the resource
 Object getAdapter(Class adapter)
           
 boolean getAllowChangeByProgram()
           
 String getAPAR()
           
 int getAuxiliaryStoragePool()
           
 boolean getChangedByProgram()
           
 String getCompiler()
           
 char getCompressionStatus()
           
 String getCreatorUserProfile()
           
 Date getDateCreated()
          Returns the date the resource was created.
 Date getDateModified()
          Returns the date the resource was last modified.
 int getDaysUsedCount()
           
 String getDomain()
           
 void getExhaustiveProperties()
          Public api version of the private retrieveExhaustiveProperties, which is to be used for knowing if the exhaustive properties are available from the cache.
 Date getLastUsedDate()
           
 String getLicensedProgram()
           
 String getObjectAuditingValue()
           
 String getObjectLevel()
           
 boolean getObjectOverflowedASP()
           
 String getOwner()
           
 IQSYSResource getParent()
          This operation is not supported at the service layer.
 String getPrimaryGroup()
           
 String getPTF()
           
 IRemoteObjectContext getRemoteObjectContext()
          Get the remote context.
 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()
          Returns the size of the resource.
 Date getSourceChangedDate()
           
 String getSourceFile()
           
 String getSourceLibrary()
           
 String getSourceMember()
           
 String getStorage()
           
 String getSystemLevel()
           
 String getSystemWhereCreated()
           
 boolean getUsageInformationUpdated()
           
 boolean getUserChanged()
           
 String getUserDefinedAttribute()
           
 boolean hasAdditionalDetails()
          Set whether this object has additional details.
 int hashCode()
           
 void setDateCreated(Date date)
           
 void setRemoteObjectContext(IRemoteObjectContext context)
          Set the context for the remote object
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectExhaustive
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
getFullName, 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.comm.interfaces.IISeriesHostObjectExhaustive
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
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
getDescription, getFullName, getLibrary, getName, getSubType, getType, setDescription, setLibrary, setName, setSubType, setType
 

Field Detail

copyright

public static String copyright
Constructor Detail

QSYSRemoteObject

public QSYSRemoteObject()
Method Detail

getAbsoluteName

public String getAbsoluteName()
Description copied from interface: IQSYSResource
Get the absolute name (includes type) for the resource

Specified by:
getAbsoluteName in interface IQSYSResource
Overrides:
getAbsoluteName in class ISeriesHostObjectBasic

getAdapter

public Object getAdapter(Class adapter)

getRemoteObjectContext

public IRemoteObjectContext getRemoteObjectContext()
Description copied from interface: IRemoteObjectContextProvider
Get the remote context.

Specified by:
getRemoteObjectContext in interface IRemoteObjectContextProvider

setRemoteObjectContext

public void setRemoteObjectContext(IRemoteObjectContext context)
Set the context for the remote object

Specified by:
setRemoteObjectContext in interface IRemoteObjectContextProvider

exists

public boolean exists()
               throws SystemMessageException,
                      InterruptedException
Description copied from class: QSYSHostObject
This operation is not supported at the service layer. Use the service API directly instead. (non-Javadoc)

Specified by:
exists in interface IQSYSResource
Overrides:
exists in class QSYSHostObject
Throws:
SystemMessageException
InterruptedException
See Also:
IQSYSResource.exists()

getExhaustiveProperties

public void getExhaustiveProperties()
Public api version of the private retrieveExhaustiveProperties, which is to be used for knowing if the exhaustive properties are available from the cache. Otherwise null checking needs to be done on method calls


getDateCreated

public Date getDateCreated()
Description copied from interface: IQSYSResource
Returns the date the resource was created.

Specified by:
getDateCreated in interface IISeriesHostObjectBasic
Specified by:
getDateCreated in interface IQSYSResource
Overrides:
getDateCreated in class ISeriesHostObjectBasic

getDateModified

public Date getDateModified()
Description copied from interface: IQSYSResource
Returns the date the resource was last modified.

Specified by:
getDateModified in interface IISeriesHostObjectBasic
Specified by:
getDateModified in interface IQSYSResource
Overrides:
getDateModified in class ISeriesHostObjectBasic

getSize

public long getSize()
Description copied from interface: IQSYSResource
Returns the size of the resource.

Specified by:
getSize in interface IISeriesHostObjectBasic
Specified by:
getSize in interface IQSYSResource
Overrides:
getSize in class ISeriesHostObjectBasic

getAuxiliaryStoragePool

public int getAuxiliaryStoragePool()
Specified by:
getAuxiliaryStoragePool in interface IISeriesHostObjectExhaustive
Overrides:
getAuxiliaryStoragePool in class ISeriesHostObjectExhaustive

getOwner

public String getOwner()
Specified by:
getOwner in interface IISeriesHostObjectExhaustive
Overrides:
getOwner in class ISeriesHostObjectExhaustive

getDomain

public String getDomain()
Specified by:
getDomain in interface IISeriesHostObjectExhaustive
Overrides:
getDomain in class ISeriesHostObjectExhaustive

getSourceFile

public String getSourceFile()
Specified by:
getSourceFile in interface IISeriesHostObjectExhaustive
Overrides:
getSourceFile in class ISeriesHostObjectExhaustive

getSourceLibrary

public String getSourceLibrary()
Specified by:
getSourceLibrary in interface IISeriesHostObjectExhaustive
Overrides:
getSourceLibrary in class ISeriesHostObjectExhaustive

getSourceMember

public String getSourceMember()
Specified by:
getSourceMember in interface IISeriesHostObjectExhaustive
Overrides:
getSourceMember in class ISeriesHostObjectExhaustive

getSourceChangedDate

public Date getSourceChangedDate()
Specified by:
getSourceChangedDate in interface IISeriesHostObjectExhaustive
Overrides:
getSourceChangedDate in class ISeriesHostObjectExhaustive

getSavedDate

public Date getSavedDate()
Specified by:
getSavedDate in interface IISeriesHostObjectExhaustive
Overrides:
getSavedDate in class ISeriesHostObjectExhaustive

getRestoredDate

public Date getRestoredDate()
Specified by:
getRestoredDate in interface IISeriesHostObjectExhaustive
Overrides:
getRestoredDate in class ISeriesHostObjectExhaustive

getCreatorUserProfile

public String getCreatorUserProfile()
Specified by:
getCreatorUserProfile in interface IISeriesHostObjectExhaustive
Overrides:
getCreatorUserProfile in class ISeriesHostObjectExhaustive

getSystemWhereCreated

public String getSystemWhereCreated()
Specified by:
getSystemWhereCreated in interface IISeriesHostObjectExhaustive
Overrides:
getSystemWhereCreated in class ISeriesHostObjectExhaustive

getResetDate

public Date getResetDate()
Specified by:
getResetDate in interface IISeriesHostObjectExhaustive
Overrides:
getResetDate in class ISeriesHostObjectExhaustive

getSaveSize

public long getSaveSize()
Specified by:
getSaveSize in interface IISeriesHostObjectExhaustive
Overrides:
getSaveSize in class ISeriesHostObjectExhaustive

getSaveSequenceNumber

public int getSaveSequenceNumber()
Specified by:
getSaveSequenceNumber in interface IISeriesHostObjectExhaustive
Overrides:
getSaveSequenceNumber in class ISeriesHostObjectExhaustive

getStorage

public String getStorage()
Specified by:
getStorage in interface IISeriesHostObjectExhaustive
Overrides:
getStorage in class ISeriesHostObjectExhaustive

getSaveCommand

public String getSaveCommand()
Specified by:
getSaveCommand in interface IISeriesHostObjectExhaustive
Overrides:
getSaveCommand in class ISeriesHostObjectExhaustive

getSaveVolumeId

public String getSaveVolumeId()
Specified by:
getSaveVolumeId in interface IISeriesHostObjectExhaustive
Overrides:
getSaveVolumeId in class ISeriesHostObjectExhaustive

getSaveDevice

public String getSaveDevice()
Specified by:
getSaveDevice in interface IISeriesHostObjectExhaustive
Overrides:
getSaveDevice in class ISeriesHostObjectExhaustive

getSaveFileName

public String getSaveFileName()
Specified by:
getSaveFileName in interface IISeriesHostObjectExhaustive
Overrides:
getSaveFileName in class ISeriesHostObjectExhaustive

getSaveLibrary

public String getSaveLibrary()
Specified by:
getSaveLibrary in interface IISeriesHostObjectExhaustive
Overrides:
getSaveLibrary in class ISeriesHostObjectExhaustive

getSaveLabel

public String getSaveLabel()
Specified by:
getSaveLabel in interface IISeriesHostObjectExhaustive
Overrides:
getSaveLabel in class ISeriesHostObjectExhaustive

getSystemLevel

public String getSystemLevel()
Specified by:
getSystemLevel in interface IISeriesHostObjectExhaustive
Overrides:
getSystemLevel in class ISeriesHostObjectExhaustive

getCompiler

public String getCompiler()
Specified by:
getCompiler in interface IISeriesHostObjectExhaustive
Overrides:
getCompiler in class ISeriesHostObjectExhaustive

getObjectLevel

public String getObjectLevel()
Specified by:
getObjectLevel in interface IISeriesHostObjectExhaustive
Overrides:
getObjectLevel in class ISeriesHostObjectExhaustive

getUserChanged

public boolean getUserChanged()
Specified by:
getUserChanged in interface IISeriesHostObjectExhaustive
Overrides:
getUserChanged in class ISeriesHostObjectExhaustive

getLicensedProgram

public String getLicensedProgram()
Specified by:
getLicensedProgram in interface IISeriesHostObjectExhaustive
Overrides:
getLicensedProgram in class ISeriesHostObjectExhaustive

getPTF

public String getPTF()
Specified by:
getPTF in interface IISeriesHostObjectExhaustive
Overrides:
getPTF in class ISeriesHostObjectExhaustive

getAPAR

public String getAPAR()
Specified by:
getAPAR in interface IISeriesHostObjectExhaustive
Overrides:
getAPAR in class ISeriesHostObjectExhaustive

getLastUsedDate

public Date getLastUsedDate()
Specified by:
getLastUsedDate in interface IISeriesHostObjectExhaustive
Overrides:
getLastUsedDate in class ISeriesHostObjectExhaustive

getUsageInformationUpdated

public boolean getUsageInformationUpdated()
Specified by:
getUsageInformationUpdated in interface IISeriesHostObjectExhaustive
Overrides:
getUsageInformationUpdated in class ISeriesHostObjectExhaustive

getDaysUsedCount

public int getDaysUsedCount()
Specified by:
getDaysUsedCount in interface IISeriesHostObjectExhaustive
Overrides:
getDaysUsedCount in class ISeriesHostObjectExhaustive

getCompressionStatus

public char getCompressionStatus()
Specified by:
getCompressionStatus in interface IISeriesHostObjectExhaustive
Overrides:
getCompressionStatus in class ISeriesHostObjectExhaustive

getAllowChangeByProgram

public boolean getAllowChangeByProgram()
Specified by:
getAllowChangeByProgram in interface IISeriesHostObjectExhaustive
Overrides:
getAllowChangeByProgram in class ISeriesHostObjectExhaustive

getChangedByProgram

public boolean getChangedByProgram()
Specified by:
getChangedByProgram in interface IISeriesHostObjectExhaustive
Overrides:
getChangedByProgram in class ISeriesHostObjectExhaustive

getUserDefinedAttribute

public String getUserDefinedAttribute()
Specified by:
getUserDefinedAttribute in interface IISeriesHostObjectExhaustive
Overrides:
getUserDefinedAttribute in class ISeriesHostObjectExhaustive

getObjectOverflowedASP

public boolean getObjectOverflowedASP()
Specified by:
getObjectOverflowedASP in interface IISeriesHostObjectExhaustive
Overrides:
getObjectOverflowedASP in class ISeriesHostObjectExhaustive

getSaveActiveDate

public Date getSaveActiveDate()
Specified by:
getSaveActiveDate in interface IISeriesHostObjectExhaustive
Overrides:
getSaveActiveDate in class ISeriesHostObjectExhaustive

getObjectAuditingValue

public String getObjectAuditingValue()
Specified by:
getObjectAuditingValue in interface IISeriesHostObjectExhaustive
Overrides:
getObjectAuditingValue in class ISeriesHostObjectExhaustive

getPrimaryGroup

public String getPrimaryGroup()
Specified by:
getPrimaryGroup in interface IISeriesHostObjectExhaustive
Overrides:
getPrimaryGroup in class ISeriesHostObjectExhaustive

setDateCreated

public void setDateCreated(Date date)
Specified by:
setDateCreated in interface IISeriesHostObjectBasic
Overrides:
setDateCreated in class ISeriesHostObjectBasic

hasAdditionalDetails

public boolean hasAdditionalDetails()
Set whether this object has additional details.

Returns:

clearCachedProperties

public void clearCachedProperties()
Description copied from interface: IQSYSObject
Clear any cached properties

Specified by:
clearCachedProperties in interface IQSYSObject
Overrides:
clearCachedProperties in class QSYSHostObject

getParent

public IQSYSResource getParent()
                        throws SystemMessageException,
                               InterruptedException
Description copied from class: QSYSHostObject
This operation is not supported at the service layer. Use the service API directly instead. (non-Javadoc)

Specified by:
getParent in interface IQSYSResource
Overrides:
getParent in class QSYSHostObject
Throws:
SystemMessageException
InterruptedException
See Also:
IQSYSResource.getParent()

equals

public boolean equals(Object obj)
Description copied from class: ISeriesHostObjectBasic
Two QSYSHostObjects objects are equal if they have the same name and library name.

Overrides:
equals in class ISeriesHostObjectBasic
See Also:
Object.equals(java.lang.Object)

hashCode

public int hashCode()
Overrides:
hashCode in class ISeriesHostObjectBasic

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.