Class i5OSLicensedProgram

  • All Implemented Interfaces:
    OSHostable, Referenceable

    public final class i5OSLicensedProgram
    extends Action
    implements OSHostable
    Enables licensed programs to be restored on an i5/OS system. At build time, the Save Licensed Program (SAVLICPGM) command is called to save the licensed program on the i5/OS build system. At install time, the Restore Licensed Program (RSTLICPGM) command is called to restore the licensed program to the target system.
    • Constructor Detail

      • i5OSLicensedProgram

        public i5OSLicensedProgram()
    • Method Detail

      • getProductID

        public java.lang.String getProductID()
        Returns the seven-character identifier of the licensed program that is saved. In i5/OS, the Display Software Resources (DSPSFWRSC) command can be used to find the identifiers for installed licensed programs.
      • getAdditionalRestoreParameters

        public java.lang.String getAdditionalRestoreParameters()
        Returns the additional parameters to pass to the RSTLICPGM command at install time.
      • setAdditionalRestoreParameters

        public void setAdditionalRestoreParameters​(java.lang.String additionalRestoreParameters)
        Defines the additional parameters to pass to the RSTLICPGM command at install time.
      • getAdditionalSaveParameters

        public java.lang.String getAdditionalSaveParameters()
        Returns the additional parameters to pass to the SAVLICPGM command at build time.
      • setAdditionalSaveParameters

        public void setAdditionalSaveParameters​(java.lang.String additionalSaveParameters)
        Defines the additional parameters to pass to the SAVLICPGM command at build time.
      • setProductID

        public void setProductID​(java.lang.String productID)
        Defines the seven-character identifier of the licensed program that is saved. In i5/OS, the Display Software Resources (DSPSFWRSC) command can be used to find the identifiers for installed licensed programs.
      • getOption

        public java.lang.String getOption()
        Returns the licensed program options to save. Use *BASE to save the base part of the licensed program, or specify the option number to save (01-99). In i5/OS, the Display Software Resources (DSPSFWRSC) command can be used to find the available options of a licensed program.
      • setOption

        public void setOption​(java.lang.String option)
        Defines the licensed program options to save. Use *BASE to save the base part of the licensed program, or specify the option number to save (01-99). In i5/OS, the Display Software Resources (DSPSFWRSC) command can be used to find the available options of a licensed program.
      • getReleaseLvl

        public java.lang.String getReleaseLvl()
        Returns the version, release, and modification level (VRM) of the licensed program to save. Use *ONLY if only one VRM is installed for the licensed program. Specify the release level in the format VxRxMx, where x is a digit (0-9). In i5/OS, the Display Software Resources (DSPSFWRSC) command can be used to find the installed release levels for a licensed program.
      • setReleaseLvl

        public void setReleaseLvl​(java.lang.String releaseLevel)
        Defines the version, release, and modification level (VRM) of the licensed program to save. Use *ONLY if only one VRM is installed for the licensed program. Specify the release level in the format VxRxMx, where x is a digit (0-9). In i5/OS, the Display Software Resources (DSPSFWRSC) command can be used to find the installed release levels for a licensed program.
      • getLanguage

        public java.lang.String getLanguage()
        Returns the native language version (NLV) used for the save operation. Specify *PRIMARY to user the system's primary language, *ALL to use all languages that the licensed program supports, or specify the four-character NLV identifier. In i5/OS, the Display Software Resources (DSPSFWRSC) command can be used to find the available NLVs for a licensed program. (This parameter is ignored if the Object Type is *PGM.)
      • setLanguage

        public void setLanguage​(java.lang.String language)
        Defines the native language version (NLV) used for the save operation. Specify *PRIMARY to user the system's primary language, *ALL to use all languages that the licensed program supports, or specify the four-character NLV identifier. In i5/OS, the Display Software Resources (DSPSFWRSC) command can be used to find the available NLVs for a licensed program. (This parameter is ignored if the Object Type is *PGM.)
      • getObjtype

        public java.lang.String getObjtype()
        Returns which objects are saved. Use *ALL to save both the program and the language objects. Use *PGM to save only the program objects. Use *LNG to save only the language objects.
      • setObjtype

        public void setObjtype​(java.lang.String objType)
        Defines which objects are saved. Use *ALL to save both the program and the language objects. Use *PGM to save only the program objects. Use *LNG to save only the language objects.
      • getTargetRelease

        public java.lang.String getTargetRelease()
        Returns the minimum supported release level of the operating system on which you intend to restore and use the licensed program. This value must be *CURRENT, *PRV, or a six-character release value in VxRxMx format (where x is a digit 0-9).
      • setTargetRelease

        public void setTargetRelease​(java.lang.String targetRelease)
        Defines the minimum supported release level of the operating system on which you intend to restore and use the licensed program. This value must be *CURRENT, *PRV, or a six-character release value in VxRxMx format (where x is a digit 0-9).
      • setResaveEachBuild

        public void setResaveEachBuild​(java.lang.String resave)
        Defines whether or not to re-save. If No, the build process uses the last copy of the licensed program that it saved and transferred to the local system (if one exists). If Yes, the licensed program is re-saved and transferred during the build. (Choose Yes if the licensed program has been changed and repackaged since the last build.)
      • getResaveEachBuild

        public java.lang.String getResaveEachBuild()
        Returns whether or not to re-save. If No, the build process uses the last copy of the licensed program that it saved and transferred to the local system (if one exists). If Yes, the licensed program is re-saved and transferred during the build. (Choose Yes if the licensed program has been changed and repackaged since the last build.)