Class HintsContext

    • Constructor Detail

      • HintsContext

        public HintsContext()
    • Method Detail

      • getDescription

        public String getDescription()
        Get the brief description of the role played by the WorkContext and any other related debugging information. This could be used by the WorkManager and the resource adapter for debugging purposes.

        Specified by:
        getDescription in interface WorkContext
        Returns:
        the associated description of the WorkContext
      • getName

        public String getName()
        Get the associated name of the WorkContext. This could be used by the WorkManager and the resource adapter for debugging purposes.

        Specified by:
        getName in interface WorkContext
        Returns:
        the associated name of the WorkContext
      • setDescription

        public void setDescription​(String description)
        Set a brief description of the role played by the instance of HintsContext and any other related debugging information. This could be used by the resource adapter and the WorkManager for logging and debugging purposes.
        Parameters:
        description - The description
      • setName

        public void setName​(String name)
        Set the associated name of the HintsContext. This could be used by the resource adapter and the WorkManager for logging and debugging purposes.
        Parameters:
        name - The name
      • setHint

        public void setHint​(String hintName,
                            Serializable value)
        Set a Hint and a related value. The hintName must be non-Null. Standard HintNames are defined in the Jakarta Connectors specification. Use of "jakarta.resource." prefixed hintNames are reserved for use by the Jakarta Connectors specification.
        Parameters:
        hintName - name of the hint to set
        value - value to set