Package com.onenetwork.platform.tools.log

Interface BizLoggerDoc

public interface BizLoggerDoc
A BizLoggerDoc (short for "Business Logger Document") captures all the freeform text and structured data to be logged using BizLogger.

  • Method Summary

    Modifier and Type Method Description
    void addMessage​(java.lang.String msg)
    Adds a new message to the list of messages for this BizLoggerDoc.
    BizLoggerDimensions getDimensions()  
    org.json.JSONArray getMessages()  
    org.json.JSONObject getProperties()
    Returns all custom properties for this BizLogger.
    java.lang.String getType()  
    java.lang.String getVersion()  
    void setProperty​(java.lang.String name, boolean value)
    Sets a custom property value.
    void setProperty​(java.lang.String name, double value)
    Sets a custom property value.
    void setProperty​(java.lang.String name, float value)
    Sets a custom property value.
    void setProperty​(java.lang.String name, int value)
    Sets a custom property value.
    void setProperty​(java.lang.String name, long value)
    Sets a custom property value.
    void setProperty​(java.lang.String name, java.lang.String value)
    Sets a custom property value.
    void setProperty​(java.lang.String name, java.util.Calendar value)
    Sets a custom property value.
    void setProperty​(java.lang.String name, org.json.JSONArray value)
    Sets a custom property value to a full, nested JSONArray.
    void setProperty​(java.lang.String name, org.json.JSONObject value)
    Sets a custom property value to a full, nested JSONObject.

  • Method Details

    • getType

      java.lang.String getType()
      Returns:
      document type used to construct this BizLogger. A different document type/version implies different properties

    • getVersion

      java.lang.String getVersion()
      Returns:
      document version used to construct this BizLogger. A different document type/version implies different properties

    • addMessage

      void addMessage​(java.lang.String msg)
      Adds a new message to the list of messages for this BizLoggerDoc.

    • getMessages

      org.json.JSONArray getMessages()
      Returns:
      the array of messages to be logged. You may mutate this array. It will never be null.

    • setProperty

      void setProperty​(java.lang.String name, java.lang.String value)
      Sets a custom property value.
      Parameters:
      name - custom property name
      value - String value

    • setProperty

      void setProperty​(java.lang.String name, long value)
      Sets a custom property value.
      Parameters:
      name - custom property name
      value - long value

    • setProperty

      void setProperty​(java.lang.String name, int value)
      Sets a custom property value.
      Parameters:
      name - custom property name
      value - int value

    • setProperty

      void setProperty​(java.lang.String name, double value)
      Sets a custom property value.
      Parameters:
      name - custom property name
      value - double value

    • setProperty

      void setProperty​(java.lang.String name, float value)
      Sets a custom property value.
      Parameters:
      name - custom property name
      value - float value

    • setProperty

      void setProperty​(java.lang.String name, boolean value)
      Sets a custom property value.
      Parameters:
      name - custom property name
      value - boolean value

    • setProperty

      void setProperty​(java.lang.String name, java.util.Calendar value)
      Sets a custom property value.
      Parameters:
      name - custom property name
      value - Calendar value

    • setProperty

      void setProperty​(java.lang.String name, org.json.JSONObject value)
      Sets a custom property value to a full, nested JSONObject.
      Parameters:
      name - custom property name
      value - JSONObject value

    • setProperty

      void setProperty​(java.lang.String name, org.json.JSONArray value)
      Sets a custom property value to a full, nested JSONArray.
      Parameters:
      name - custom property name
      value - JSONArray value

    • getProperties

      org.json.JSONObject getProperties()
      Returns all custom properties for this BizLogger. Does NOT include standard properties like type/version/Dimensions. You may mutate this object.

    • getDimensions

      BizLoggerDimensions getDimensions()
      Returns:
      BizLoggerDimensions object into which you may log dimension values for this document.