Package org.odpi.openmetadata.adapters.connectors.integration.smartcollections.ffdc

Enum Class SmartCollectionsAuditCode

java.lang.Object
java.lang.Enum<SmartCollectionsAuditCode>
org.odpi.openmetadata.adapters.connectors.integration.smartcollections.ffdc.SmartCollectionsAuditCode
All Implemented Interfaces:
Serializable, Comparable<SmartCollectionsAuditCode>, Constable, AuditLogMessageSet
public enum SmartCollectionsAuditCode extends Enum<SmartCollectionsAuditCode> implements AuditLogMessageSet
The SmartCollectionsAuditCode is used to define the message content for the Audit Log. The 5 fields in the enum are:
  • Log Message Id - to uniquely identify the message
  • Severity - is this an event, decision, action, error, or exception
  • Log Message Text - includes placeholder to allow additional values to be captured
  • SystemAction - describes the result of the situation
  • UserAction - describes how a user should correct the situation

  • Enum Constant Details

    • REFRESHING_RESULTS_SET

      public static final SmartCollectionsAuditCode REFRESHING_RESULTS_SET
      SMART-COLLECTIONS-INTEGRATION-CONNECTOR-0001 - Connector {0} is refreshing the membership of results set {1}

    • WRONG_NUMBER_OF_SAVED_QUERIES

      public static final SmartCollectionsAuditCode WRONG_NUMBER_OF_SAVED_QUERIES
      SMART-COLLECTIONS-INTEGRATION-CONNECTOR-0002 - Connector {0} found {1} saved queries attached to results set {2}; expecting to find at most one

    • RESULTS_SET_REFRESHED

      public static final SmartCollectionsAuditCode RESULTS_SET_REFRESHED
      SMART-COLLECTIONS-INTEGRATION-CONNECTOR-0003 - Connector {0} completed the membership refresh of results set {1}: {2} members added, {3} members removed

    • UNEXPECTED_EXCEPTION

      public static final SmartCollectionsAuditCode UNEXPECTED_EXCEPTION
      SMART-COLLECTIONS-INTEGRATION-CONNECTOR-0004 - The Smart Collections Integration Connector {0} received an unexpected {1} exception during method {2} while refreshing results set {3}; the error message was: {4}

  • Method Details

    • values

      public static SmartCollectionsAuditCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SmartCollectionsAuditCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition()
      Retrieve a message definition object for logging. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for logging. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Parameters:
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      Returns:
      message definition object.

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<SmartCollectionsAuditCode>
      Returns:
      string of property names and values for this enum