com.ibm.jtopenlite.command.program.object

Class RetrieveObjectDescription

  • java.lang.Object
    • com.ibm.jtopenlite.command.program.object.RetrieveObjectDescription
  • All Implemented Interfaces:
    Program


    public class RetrieveObjectDescription
    extends java.lang.Object
    implements Program
    QUSROBJD This class fully implements the V5R4 specification of QUSROBJD.
    • Constructor Detail

      • RetrieveObjectDescription

        public RetrieveObjectDescription(java.lang.String objectLibrary,
                                 java.lang.String objectName,
                                 java.lang.String objectType,
                                 int format)
    >
    • Method Detail

      • getProgramName

        public java.lang.String getProgramName()
        Description copied from interface: Program
        Returns the name of the program object.
        Specified by:
        getProgramName in interface Program
      • getProgramLibrary

        public java.lang.String getProgramLibrary()
        Description copied from interface: Program
        Returns the library of the program object.
        Specified by:
        getProgramLibrary in interface Program
      • getNumberOfParameters

        public int getNumberOfParameters()
        Description copied from interface: Program
        Returns the number of parameters for this program.
        Specified by:
        getNumberOfParameters in interface Program
      • getTempDataBuffer

        public final byte[] getTempDataBuffer()
        Description copied from interface: Program
        The implementor can create their own temp byte array for the output parameter size and reuse it each time a call is performed, or for more than one parameter on the same call. The implementor can choose to ignore this, and simply return null. The command connection checks to see if the buffer returned by this method is not null and large enough to accommodate the output parameter size.
        Specified by:
        getTempDataBuffer in interface Program
      • newCall

        public void newCall()
        Description copied from interface: Program
        Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
        Specified by:
        newCall in interface Program
      • setFormat

        public void setFormat(int format)
      • setObjectNameToRetrieve

        public void setObjectNameToRetrieve(java.lang.String name)
      • setObjectLibraryToRetrieve

        public void setObjectLibraryToRetrieve(java.lang.String lib)
      • setObjectTypeToRetrieve

        public void setObjectTypeToRetrieve(java.lang.String type)
      • getObjectName

        public java.lang.String getObjectName()
        All formats.
      • getObjectLibrary

        public java.lang.String getObjectLibrary()
        All formats.
      • getObjectType

        public java.lang.String getObjectType()
        All formats.
      • getReturnLibrary

        public java.lang.String getReturnLibrary()
        All formats.
      • getObjectASPNumber

        public int getObjectASPNumber()
        All formats.
      • getObjectOwner

        public java.lang.String getObjectOwner()
        All formats.
      • getObjectDomain

        public java.lang.String getObjectDomain()
        All formats.
      • getCreationDateAndTime

        public java.lang.String getCreationDateAndTime()
        All formats.
      • getObjectChangeDateAndTime

        public java.lang.String getObjectChangeDateAndTime()
        All formats.
      • getExtendedObjectAttribute

        public java.lang.String getExtendedObjectAttribute()
        FORMAT_OBJD0200, FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getTextDescription

        public java.lang.String getTextDescription()
        FORMAT_OBJD0200, FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSourceFileName

        public java.lang.String getSourceFileName()
        FORMAT_OBJD0200, FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSourceFileLibrary

        public java.lang.String getSourceFileLibrary()
        FORMAT_OBJD0200, FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSourceFileMember

        public java.lang.String getSourceFileMember()
        FORMAT_OBJD0200, FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSourceFileUpdatedDateAndTime

        public java.lang.String getSourceFileUpdatedDateAndTime()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getObjectSavedDateAndTime

        public java.lang.String getObjectSavedDateAndTime()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getObjectRestoredDateAndTime

        public java.lang.String getObjectRestoredDateAndTime()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getCreatorUserProfile

        public java.lang.String getCreatorUserProfile()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSystemWhereObjectWasCreated

        public java.lang.String getSystemWhereObjectWasCreated()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getResetDate

        public java.lang.String getResetDate()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSavedSize

        public int getSavedSize()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSaveSequenceNumber

        public int getSaveSequenceNumber()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getStorage

        public java.lang.String getStorage()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSaveCommand

        public java.lang.String getSaveCommand()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSaveVolumeID

        public java.lang.String getSaveVolumeID()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSaveDevice

        public java.lang.String getSaveDevice()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSaveFileName

        public java.lang.String getSaveFileName()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSaveFileLibrary

        public java.lang.String getSaveFileLibrary()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSaveLabel

        public java.lang.String getSaveLabel()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getSystemLevel

        public java.lang.String getSystemLevel()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getCompiler

        public java.lang.String getCompiler()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getObjectLevel

        public java.lang.String getObjectLevel()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getUserChanged

        public java.lang.String getUserChanged()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getLicensedProgram

        public java.lang.String getLicensedProgram()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getPTF

        public java.lang.String getPTF()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getAPAR

        public java.lang.String getAPAR()
        FORMAT_OBJD0300, FORMAT_OBJD0400.
      • getLastUsedDate

        public java.lang.String getLastUsedDate()
        FORMAT_OBJD0400.
      • getUsageInformationUpdated

        public java.lang.String getUsageInformationUpdated()
        FORMAT_OBJD0400.
      • getDaysUsedCount

        public int getDaysUsedCount()
        FORMAT_OBJD0400.
      • getObjectSize

        public int getObjectSize()
        FORMAT_OBJD0400.
      • getObjectSizeMultiplier

        public int getObjectSizeMultiplier()
        FORMAT_OBJD0400.
      • getObjectCompressionStatus

        public java.lang.String getObjectCompressionStatus()
        FORMAT_OBJD0400.
      • getAllowChangeByProgram

        public java.lang.String getAllowChangeByProgram()
        FORMAT_OBJD0400.
      • getChangedByProgram

        public java.lang.String getChangedByProgram()
        FORMAT_OBJD0400.
      • getUserDefinedAttribute

        public java.lang.String getUserDefinedAttribute()
        FORMAT_OBJD0400.
      • getObjectOverflowedASPIndicator

        public java.lang.String getObjectOverflowedASPIndicator()
        FORMAT_OBJD0400.
      • getSaveActiveDateAndTime

        public java.lang.String getSaveActiveDateAndTime()
        FORMAT_OBJD0400.
      • getObjectAuditingValue

        public java.lang.String getObjectAuditingValue()
        FORMAT_OBJD0400.
      • getPrimaryGroup

        public java.lang.String getPrimaryGroup()
        FORMAT_OBJD0400.
      • getJournalStatus

        public java.lang.String getJournalStatus()
        FORMAT_OBJD0400.
      • getJournalName

        public java.lang.String getJournalName()
        FORMAT_OBJD0400.
      • getJournalLibrary

        public java.lang.String getJournalLibrary()
        FORMAT_OBJD0400.
      • getJournalImages

        public java.lang.String getJournalImages()
        FORMAT_OBJD0400.
      • getJournalEntriesToBeOmitted

        public java.lang.String getJournalEntriesToBeOmitted()
        FORMAT_OBJD0400.
      • getJournalStartDateAndTime

        public java.lang.String getJournalStartDateAndTime()
        FORMAT_OBJD0400.
      • getDigitallySigned

        public java.lang.String getDigitallySigned()
        FORMAT_OBJD0400.
      • getSavedSizeInUnits

        public int getSavedSizeInUnits()
        FORMAT_OBJD0400.
      • getSavedSizeMultiplier

        public int getSavedSizeMultiplier()
        FORMAT_OBJD0400.
      • getLibraryASPNumber

        public int getLibraryASPNumber()
        FORMAT_OBJD0400.
      • getObjectASPDeviceName

        public java.lang.String getObjectASPDeviceName()
        FORMAT_OBJD0400.
      • getLibraryASPDeviceName

        public java.lang.String getLibraryASPDeviceName()
        FORMAT_OBJD0400.
      • getDigitallySignedBySystemTrustedSource

        public java.lang.String getDigitallySignedBySystemTrustedSource()
        FORMAT_OBJD0400.
      • getDigitallySignedMoreThanOnce

        public java.lang.String getDigitallySignedMoreThanOnce()
        FORMAT_OBJD0400.
      • getPrimaryAssociatedSpaceSize

        public int getPrimaryAssociatedSpaceSize()
        FORMAT_OBJD0400.
      • getOptimumSpaceAlignment

        public java.lang.String getOptimumSpaceAlignment()
        FORMAT_OBJD0400.
      • getObjectASPGroupName

        public java.lang.String getObjectASPGroupName()
        FORMAT_OBJD0400.
      • getLibraryASPGroupName

        public java.lang.String getLibraryASPGroupName()
        FORMAT_OBJD0400.
      • getStartingJournalReceiverNameForApply

        public java.lang.String getStartingJournalReceiverNameForApply()
        FORMAT_OBJD0400.
      • getStartingJournalReceiverLibrary

        public java.lang.String getStartingJournalReceiverLibrary()
        FORMAT_OBJD0400.
      • getStartingJournalReceiverLibraryASPDeviceName

        public java.lang.String getStartingJournalReceiverLibraryASPDeviceName()
        FORMAT_OBJD0400.
      • getStartingJournalReceiverLibraryASPGroupName

        public java.lang.String getStartingJournalReceiverLibraryASPGroupName()
        FORMAT_OBJD0400.
      • getParameterInputLength

        public int getParameterInputLength(int parmIndex)
        Description copied from interface: Program
        Returns the input length of the parameter at the specified index.
        Specified by:
        getParameterInputLength in interface Program
      • getParameterOutputLength

        public int getParameterOutputLength(int parmIndex)
        Description copied from interface: Program
        Returns the output length of the parameter at the specified index.
        Specified by:
        getParameterOutputLength in interface Program
      • getParameterType

        public int getParameterType(int parmIndex)
        Description copied from interface: Program
        Returns the type of parameter at the specified index.
        Specified by:
        getParameterType in interface Program
        See Also:
        Parameter
      • getParameterInputData

        public byte[] getParameterInputData(int parmIndex)
        Description copied from interface: Program
        Returns the input data of the parameter at the specified index.
        Specified by:
        getParameterInputData in interface Program
      • setParameterOutputData

        public void setParameterOutputData(int parmIndex,
                                  byte[] data,
                                  int maxLength)
        Description copied from interface: Program
        Sets the output data for the parameter at the specified index.
        Specified by:
        setParameterOutputData in interface Program