Package com.onenetwork.platform.tools.log

Interface BizLoggerDimensions

public interface BizLoggerDimensions
Captures standard, widely-recognized dimensions against a BizLoggerDocument. By populating these dimensions, modules enable end-users to search across document types for common dimensions. For example, 'show me all logs related to item "SKU-1001"'.

  • Method Summary

    Modifier and Type Method Description
    void addEnterprise​(java.lang.String entName)
    Adds the given enterprise to the list of dimensions.
    void addItem​(java.lang.String entName, java.lang.String itemName)
    Adds the given item to the list of dimensions.
    void addOrganization​(java.lang.String entName, java.lang.String orgName)
    Adds the given organization to the list of dimensions.
    void addProductGroupLevel​(java.lang.String entName, java.lang.String typeName, java.lang.String level1Name, java.lang.String level2Name, java.lang.String level3Name, java.lang.String level4Name, java.lang.String level5Name)
    Adds the given ProductGroupLevel to the list of dimensions.
    void addSite​(java.lang.String entName, java.lang.String orgName, java.lang.String siteName)
    Adds the given site to the list of dimensions.
    void addSiteGroupLevel​(java.lang.String entName, java.lang.String typeName, java.lang.String level1Name, java.lang.String level2Name, java.lang.String level3Name, java.lang.String level4Name)
    Adds the given SiteGroupLevel to the list of dimensions.
    void addTransactionDate​(java.util.Calendar cal)
    Adds the given date to the list of dimensions.

  • Method Details

    • addEnterprise

      void addEnterprise​(java.lang.String entName)
      Adds the given enterprise to the list of dimensions. Duplicate entries will be automatically omitted.
      Parameters:
      entName - enterprise name

    • addItem

      void addItem​(java.lang.String entName, java.lang.String itemName)
      Adds the given item to the list of dimensions. As a side effect, automatically adds the parent enterprise to the list of dimensions. Duplicate entries will be automatically omitted.
      Parameters:
      entName - enterprise name
      itemName - item name

    • addOrganization

      void addOrganization​(java.lang.String entName, java.lang.String orgName)
      Adds the given organization to the list of dimensions. As a side effect, automatically adds the parent enterprise to the list of dimensions. Duplicate entries will be automatically omitted.
      Parameters:
      entName - enterprise name
      orgName - organization name

    • addSite

      void addSite​(java.lang.String entName, java.lang.String orgName, java.lang.String siteName)
      Adds the given site to the list of dimensions. As a side effect, automatically adds the parent enterprise and org to the list of dimensions. Duplicate entries will be automatically omitted.
      Parameters:
      entName - enterprise name
      orgName - organization name
      siteName - site name

    • addProductGroupLevel

      void addProductGroupLevel​(java.lang.String entName, java.lang.String typeName, java.lang.String level1Name, java.lang.String level2Name, java.lang.String level3Name, java.lang.String level4Name, java.lang.String level5Name)
      Adds the given ProductGroupLevel to the list of dimensions. As a side effect, automatically adds the parent enterprise the list of dimensions. Duplicate entries will be automatically omitted.
      Parameters:
      entName - enterprise name
      typeName - type name
      level1Name - level1 name
      level2Name - level2 name
      level3Name - level3 name
      level4Name - level4 name
      level5Name - level5 name

    • addSiteGroupLevel

      void addSiteGroupLevel​(java.lang.String entName, java.lang.String typeName, java.lang.String level1Name, java.lang.String level2Name, java.lang.String level3Name, java.lang.String level4Name)
      Adds the given SiteGroupLevel to the list of dimensions. As a side effect, automatically adds the parent enterprise the list of dimensions. Duplicate entries will be automatically omitted.
      Parameters:
      entName - enterprise name
      typeName - type name
      level1Name - level1 name
      level2Name - level2 name
      level3Name - level3 name
      level4Name - level4 name
      level5Name - level5 name

    • addTransactionDate

      void addTransactionDate​(java.util.Calendar cal)
      Adds the given date to the list of dimensions. A transaction date is distinct from the date the message was logged ... for example, one might log the expected delivery date for an order. Duplicate entries will be automatically omitted.
      Parameters:
      cal - transaction date value