Package com.ptc.core.util.feedback.common

Interface FeedbackSpec

All Known Implementing Classes:
DefaultFeedbackSpec
public interface FeedbackSpec

This interface is the key that is used to bind clients to a feedback source.

Supported API: true

Extendable: false

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    KEY
    Label for the attribute; Attribute key is required due to WTContext-based implementation, and it is used as key in WTContext's Hashtable.
    static final String
    LOGGING_ENABLED
    Label for the attribute; If true logging will be enabled for the DefaultFeedbackModel associated with this FeedbackSpec.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getKey()
    Gets the value of the attribute: KEY.
    boolean
    isLoggingEnabled()
    Gets the value of the attribute: LOGGING_ENABLED.
    void
    setKey(Object a_Key)
    Sets the value of the attribute: KEY.
    void
    setLoggingEnabled(boolean a_LoggingEnabled)
    Sets the value of the attribute: LOGGING_ENABLED.

  • Field Details

    • KEY

      static final String KEY
      Label for the attribute; Attribute key is required due to WTContext-based implementation, and it is used as key in WTContext's Hashtable.

      Supported API: true
      See Also:

    • LOGGING_ENABLED

      static final String LOGGING_ENABLED
      Label for the attribute; If true logging will be enabled for the DefaultFeedbackModel associated with this FeedbackSpec. Default is false.

      Supported API: true
      See Also:

  • Method Details

    • getKey

      Object getKey()
      Gets the value of the attribute: KEY. Attribute key is required due to WTContext-based implementation, and it is used as key in WTContext's Hashtable.

      Supported API: true
      Returns:
      Object

    • setKey

      void setKey(Object a_Key)
      Sets the value of the attribute: KEY. Attribute key is required due to WTContext-based implementation, and it is used as key in WTContext's Hashtable.

      Supported API: true
      Parameters:
      a_Key -

    • isLoggingEnabled

      boolean isLoggingEnabled()
      Gets the value of the attribute: LOGGING_ENABLED. If true logging will be enabled for the DefaultFeedbackModel associated with this FeedbackSpec. Default is false.

      Supported API: true
      Returns:
      boolean

    • setLoggingEnabled

      void setLoggingEnabled(boolean a_LoggingEnabled) throws WTPropertyVetoException
      Sets the value of the attribute: LOGGING_ENABLED. If true logging will be enabled for the DefaultFeedbackModel associated with this FeedbackSpec. Default is false.

      Supported API: true
      Parameters:
      a_LoggingEnabled -
      Throws:
      WTPropertyVetoException