com.ibm.as400.access

Class Product

  • java.lang.Object
    • com.ibm.as400.access.Product

  • public class Product
extends java.lang.Object
    Represents a licensed product on the system. The isInstalled() method should be called to verify that the product is installed on the system. If the product is not installed, other information returned by getters in this class might not be valid.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String LOAD_STATE_CHECK_ERROR
      Constant indicating that the Check Product Option (CHKPRDOPT) command was used for this product load, but the postoperation exit program failed or indicated that an error was found.
      static java.lang.String LOAD_STATE_DEFINED_NO_OBJECT
      Constant indicating that the product load is defined but the product load object for this load does not exist.
      static java.lang.String LOAD_STATE_DEFINED_OBJECT_EXISTS
      Constant indicating that the product load object exists, but before it can be saved using the Save Licensed Program (SAVLICPGM) command, it must be packaged with either the Package Product Option (PKGPRDOPT) command or the Package Product Option (QSZPKGPO) API.
      static java.lang.String LOAD_STATE_IBM_SUPPLIED_NOT_COMPATIBLE
      Constant indicating that this product is an IBM-supplied product and it is not compatible with the currently installed release level of the System i operating system.
      static java.lang.String LOAD_STATE_INSTALLED
      Constant indicating that the product load was installed successfully.
      static java.lang.String LOAD_STATE_INSTALLED_DELETE_IN_PROGRESS
      Constant indicating that a Delete Licensed Program (DLTLICPGM) command is in progress.
      static java.lang.String LOAD_STATE_INSTALLED_RESTORE_FAILED
      Constant indicating that a Restore Licensed Program (RSTLICPGM) command failed.
      static java.lang.String LOAD_STATE_INSTALLED_RESTORE_FAILED_EXIT_PROGRAM_FAILED
      Constant indicating that a Restore Licensed Program (RSTLICPGM) command did not complete successfully.
      static java.lang.String LOAD_STATE_INSTALLED_RESTORE_IN_PROGRESS
      Constant indicating that a Restore Licensed Program (RSTLICPGM) command is in progress.
      static java.lang.String LOAD_STATE_PACKAGED
      Constant indicating that the product load object for this load has been packaged with the Package Product Option (PKGPRDOPT) command or the Package Product Option (QSZPKGPO) API.
      static java.lang.String LOAD_STATE_PACKAGED_DAMAGED
      Constant indicating that the product load object for this load has been packaged with the Package Product Option (PKGPRDOPT) command or the Package Product Option (QSZPKGPO) API, but an object was found to be damaged the last time that the Check Product Option (CHKPRDOPT) command or Save Licensed Program (SAVLICPGM) command was used for this load.
      static java.lang.String LOAD_STATE_PACKAGED_DELETE_IN_PROGRESS
      Constant indicating that a Delete Licensed Program (DLTLICPGM) command is in progress.
      static java.lang.String LOAD_STATE_PACKAGED_DELETED
      Constant indicating that the product load object for this load has been packaged with the Package Product Option (PKGPRDOPT) command or the Package Product Option (QSZPKGPO) API, but either an attempt was made to delete the product load using the Delete Licensed Program (DLTLICPGM) command and the attempt failed, or a packaged object was missing the last time the Check Product Option (CHKPRDOPT) command or Save Licensed Program (SAVLICPGM) command was used for this load.
      static java.lang.String LOAD_STATE_PACKAGED_RENAMED
      Constant indicating that the product load object for this load has been packaged with the Package Product Option (PKGPRDOPT) command or the Package Product Option (QSZPKGPO) API, but either a development library or folder was renamed when the product does not allow dynamic naming, or the product definition or product load for a packaged load was renamed or moved to another library.
      static java.lang.String LOAD_STATE_PACKAGED_RESTORE_FAILED
      Constant indicating that a Restore Licensed Program (RSTLICPGM) command failed.
      static java.lang.String LOAD_STATE_PACKAGED_RESTORE_FAILED_EXIT_PROGRAM_FAILED
      Constant indicating that a Restore Licensed Program (RSTLICPGM) command did not complete successfully.
      static java.lang.String LOAD_STATE_PACKAGED_RESTORE_IN_PROGRESS
      Constant indicating that a Restore Licensed Program (RSTLICPGM) command is in progress.
      static java.lang.String LOAD_STATE_RESTORED
      Constant indicating that the product load object for this load was loaded on to the system by the Restore Licensed Program (RSTLICPGM) command.
      static java.lang.String LOAD_STATE_RESTORED_DAMAGED
      Constant indicating that the product load object for this load was installed by the Restore Licensed Program (RSTLICPGM) command, but an object is damaged.
      static java.lang.String LOAD_STATE_RESTORED_DELETED
      Constant indicating that the product load object for this load was installed by the Restore Licensed Program (RSTLICPGM) command, but either an object was found to be missing when the Check Product Option (CHKPRDOPT) command or the Save Licensed Program (SAVLICPGM) command was used, or an error occurred while the Delete Licensed Program (DLTLICPGM) command was being used.
      static java.lang.String LOAD_STATE_RESTORED_EXIT_PROGRAM_FAILED
      Constant indicating that the product load object for this load was loaded on to the system by the Restore Licensed Program (RSTLICPGM) command but a postoperation exit program failed.
      static java.lang.String LOAD_STATE_RESTORED_RENAMED
      Constant indicating that an installed library or folder was renamed, but the product does not allow dynamic naming.
      static java.lang.String LOAD_TYPE_CODE
      Constant indicating a product load type of *CODE.
      static java.lang.String LOAD_TYPE_LANGUAGE
      Constant indicating a product load type of *LNG.
      static java.lang.String PRODUCT_FEATURE_CODE
      Constant indicating a feature ID of *CODE.
      static java.lang.String PRODUCT_ID_OPERATING_SYSTEM
      Constant indicating a product ID of *OPSYS.
      static java.lang.String PRODUCT_OPTION_BASE
      Constant indicating a product option of *BASE.
      static java.lang.String PRODUCT_RELEASE_ANY
      Constant indicating that the release level of the product should be determined at runtime by the system.
      static java.lang.String PRODUCT_RELEASE_CURRENT
      Constant indicating a release level of *CUR.
      static java.lang.String PRODUCT_RELEASE_ONLY
      Constant indicating a release level of *ONLY.
      static java.lang.String PRODUCT_RELEASE_PREVIOUS
      Constant indicating a release level of *PRV.
      static java.lang.String REGISTRATION_TYPE_CUSTOMER
      Constant indicating that the registration type *CUSTOMER was specified when the product load or product definition was created.
      static java.lang.String REGISTRATION_TYPE_PHONE
      Constant indicating that the registration type *PHONE was specified when the product load or product definition was created.
      static java.lang.String REGISTRATION_TYPE_SYSTEM
      Constant indicating that the registration type is the same as the registration type for the operating system.
      static int REQUIREMENTS_BASE_TOO_OLD
      Constant indicating that the release of the *BASE is too old compared to the option.
      static int REQUIREMENTS_MET
      Constant indicating that the releases of the *BASE and option meet all requirements.
      static int REQUIREMENTS_OPTION_TOO_OLD
      Constant indicating that the release of the option is too old compared to the *BASE.
      static int REQUIREMENTS_UNKNOWN
      Constant indicating that there is not enough information available to determine if the release requirements have been met.
      static java.lang.String SYMBOLIC_LOAD_STATE_CREATED
      Constant indicating that the product load object for this load exists.
      static java.lang.String SYMBOLIC_LOAD_STATE_DAMAGED
      Constant indicating that either the product load object has been damaged (if this option is something other than the base option or the load type is a language load), or the product definition for this product ID and release level has been damaged or the product load object has been damaged (if this option is for the base option and code load type).
      static java.lang.String SYMBOLIC_LOAD_STATE_DEFINED
      Constant indicating that the load is defined but the product load object for this load does not exist.
      static java.lang.String SYMBOLIC_LOAD_STATE_INSTALLED
      Constant indicating that the product load object for this load was loaded on to the system by the Restore Licensed Program (RSTLICPGM) command.
      static java.lang.String SYMBOLIC_LOAD_STATE_LOADED
      Constant indicating that either a Restore Licensed Program (RSTLICPGM) function is in progress, a Delete Licensed Program (DLTLICPGM) function is in progress, or the product was created previous to V2R2M0 and there was an error during the process of converting product information.
      static java.lang.String SYMBOLIC_LOAD_STATE_PACKAGED
      Constant indicating that the product load object for this load has been packaged with the Package Product Option (PKGPRDOPT) command.

    • Constructor Summary

      Constructors 
      Constructor and Description
      Product(AS400 system, java.lang.String productID)
      Constructs a Product object.
      Product(AS400 system, java.lang.String productID, java.lang.String productOption)
      Constructs a Product object.
      Product(AS400 system, java.lang.String productID, java.lang.String productOption, java.lang.String releaseLevel, java.lang.String featureID)
      Constructs a Product object.
      Product(AS400 system, java.lang.String productID, java.lang.String productOption, java.lang.String releaseLevel, java.lang.String loadType, java.lang.String languageID)
      Constructs a Product object.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean allowsDynamicNaming()
      Indicates if the names of product libraries and root folders for this product option can be dynamically changed without causing a product error.
      boolean allowsMixedReleases()
      Indicates if this product allows mixed releases between its *BASE and options.
      boolean allowsMultipleReleases()
      Indicates if this product can be installed at a release level different from the current release level without installing over a current release.
      java.lang.String getCurrentCopyright()
      Returns the value specified for the copyright current year when the product definition for this product load was created.
      java.lang.String getDescriptionID()
      Returns the message ID associated with this product option.
      java.lang.String getDescriptionMessageFile()
      Returns the full pathname of the message file that contains the messages describing the product and its options.
      java.lang.String getDescriptionText()
      Retrieves the description text for this product's message ID out of this product's message file.
      ProductDirectoryInformation[] getDirectoryInformation()
      Returns the list of product directories for this product.
      java.lang.String getFeatureID()
      Returns the feature ID for this product.
      java.lang.String getFirstCopyright()
      Returns the value specified for the copyright first year when the product definition for this product load was created.
      java.lang.String getLevel()
      Returns the release level of this product.
      ProductLicense getLicense()
      Returns a ProductLicense object representing license information for this product.
      java.lang.String getLoadState()
      Returns the state of the product load for which information was retrieved.
      java.lang.String getLoadType()
      Returns the type of product load for which information was retrieved.
      java.lang.String getMinimumRequiredRelease()
      Returns the minimum release level that is allowed for the option that will run with the current level of the *BASE option for the product.
      java.lang.String getMinimumRequiredReleaseForBase()
      Returns the minimum release level that is allowed for the *BASE option that will run with the current level of the option for the product.
      java.lang.String getMinimumTargetRelease()
      Returns the minimum operating system release to which the Save Licensed Program (SAVLICPGM) command will allow the product to be saved.
      java.lang.String getPrimaryLanguageFeatureID()
      Returns the primary language feature ID for this product.
      java.lang.String getProductID()
      Returns the product ID for this product.
      java.lang.String getProductOption()
      Returns the product option for this product.
      Product[] getProductOptions()
      Returns the list of product options for this product ID.
      PTF[] getPTFs(boolean includeSupersededPTFs)
      Returns the list of Program Temporary Fixes (PTFs) on the system for this product.
      java.lang.String getRegistrationType()
      Returns the registration type associated with this product.
      java.lang.String getRegistrationValue()
      Returns the registration value associated with this product.
      java.util.Date getReleaseDate()
      Returns the value specified for the release date when the product definition for this product load was created.
      java.lang.String getReleaseLevel()
      Returns the release level for this product.
      int getRequirementsMet()
      Returns the reason why the release requirements between the base and option may or may not be in error.
      java.lang.String getSymbolicLoadState()
      Returns the symbolic load state for which information was retrieved.
      AS400 getSystem()
      Returns the system.
      boolean isInstalled()
      Indicates whether or not this product is installed on the system.
      boolean isLoadInError()
      Indicates if there is a known error for this product load.
      boolean isSupported()
      Indicates whether this product feature is currently supported.
      boolean refresh()
      Refreshes the current values and settings for this Product by retrieving all of them from the system.
      java.lang.String toString()
      Returns a String representation of this product in the format "product ID/product option/release level".

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait