com.ibm.as400.access

Class PanelGroupHelpIdentifier

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

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int STATUS_FOUND
      Constant indicating that the keyword specified for this help identifier and panel group was found and information about the help identifier was retrieved.
      static int STATUS_NAME_NOT_CORRECT
      Constant indicating that the keyword specified for this help identifier and panel group was not correct.
      static int STATUS_OBJECT_ACCESS_FAILURE
      Constant indicating that the system encountered a problem while accessing the panel group or specified keyword information.
      static int STATUS_UNKNOWN
      Constant indicating that the system returned a status code that is not known.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getAnchor()
      Returns the name of the anchor within the help document for this help identifier.
      java.lang.String getName()
      Returns the name of the help identifier.
      java.lang.String getPath()
      Returns the path of the panel group from whence this help identifier came.
      int getStatus()
      Returns the state of the information for this help identifier.
      java.lang.String toString()
      Returns a String representation of this help identifier.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • STATUS_NAME_NOT_CORRECT

        public static final int STATUS_NAME_NOT_CORRECT
        Constant indicating that the keyword specified for this help identifier and panel group was not correct.
        See Also:
        Constant Field Values

      • STATUS_FOUND

        public static final int STATUS_FOUND
        Constant indicating that the keyword specified for this help identifier and panel group was found and information about the help identifier was retrieved.
        See Also:
        Constant Field Values

      • STATUS_OBJECT_ACCESS_FAILURE

        public static final int STATUS_OBJECT_ACCESS_FAILURE
        Constant indicating that the system encountered a problem while accessing the panel group or specified keyword information. Check the remote command host server job log for details.
        See Also:
        Constant Field Values

      • STATUS_UNKNOWN

        public static final int STATUS_UNKNOWN
        Constant indicating that the system returned a status code that is not known.
        See Also:
        Constant Field Values

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name of the help identifier.
        Returns:
        The help identifier name.

      • getPath

        public java.lang.String getPath()
        Returns the path of the panel group from whence this help identifier came.
        Returns:
        The path.

      • getStatus

        public int getStatus()
        Returns the state of the information for this help identifier. Possible values are:
        • STATUS_NAME_NOT_CORRECT - The system could not find the help identifier.
        • STATUS_FOUND - The system found the help identifier and retrieved its information.
        • STATUS_OBJECT_ACCESS_FAILURE - The system could not retrieve the help identifier information for some reason. See the remote command host server job log for details.
        • STATUS_UNKNOWN - The system returned a help identifier status that is not known.
        Returns:
        The status.

      • getAnchor

        public java.lang.String getAnchor()
        Returns the name of the anchor within the help document for this help identifier.
        Returns:
        The anchor name.

      • toString

        public java.lang.String toString()
        Returns a String representation of this help identifier.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The string.
JTOpen 11.2