Class AuditLogReport

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    OMRSAuditLogReport

    public class AuditLogReport
    extends java.lang.Object
    implements java.io.Serializable
    AuditLogReport is a container for returning information about a hierarchy of audit logs.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Validate that an object is equal depending on their stored values.
      java.util.List<AuditLogReport> getChildAuditLogReports()
      Return the reports for the hierarchy of audit logs nested in this audit log.
      AuditLogReportingComponent getReportingComponent()
      Return the description of the component that is using this audit log.
      java.util.Map<java.lang.Integer,​java.lang.Integer> getSeverityCount()
      Return the count of log records for each severity code.
      java.util.Map<java.lang.Integer,​java.util.List<java.lang.String>> getSeverityIdentification()
      Return the map of severity codes to severity names - if the audit log is set up correctly they should be 1-1.
      int hashCode()
      Return a hash code based on the values of this object.
      void setChildAuditLogReports​(java.util.List<AuditLogReport> childAuditLogReports)
      Set up the reports for the hierarchy of audit logs nested in this audit log.
      void setReportingComponent​(AuditLogReportingComponent reportingComponent)
      Set up the description of the component that is using this audit log.
      void setSeverityCount​(java.util.Map<java.lang.Integer,​java.lang.Integer> severityCount)
      Set up the count of log records for each severity code.
      void setSeverityIdentification​(java.util.Map<java.lang.Integer,​java.util.List<java.lang.String>> severityIdentification)
      Set up the map of severity codes to severity names - if the audit log is set up correctly they should be 1-1.
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AuditLogReport

        public AuditLogReport()
        Default constructor
      • AuditLogReport

        public AuditLogReport​(AuditLogReport template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getReportingComponent

        public AuditLogReportingComponent getReportingComponent()
        Return the description of the component that is using this audit log.
        Returns:
        component id, name, description and doc URL
      • setReportingComponent

        public void setReportingComponent​(AuditLogReportingComponent reportingComponent)
        Set up the description of the component that is using this audit log.
        Parameters:
        reportingComponent - component id, name, description and doc URL
      • getChildAuditLogReports

        public java.util.List<AuditLogReport> getChildAuditLogReports()
        Return the reports for the hierarchy of audit logs nested in this audit log.
        Returns:
        reports from hierarchy of child audit logs
      • setChildAuditLogReports

        public void setChildAuditLogReports​(java.util.List<AuditLogReport> childAuditLogReports)
        Set up the reports for the hierarchy of audit logs nested in this audit log.
        Parameters:
        childAuditLogReports - reports from hierarchy of child audit logs
      • getSeverityIdentification

        public java.util.Map<java.lang.Integer,​java.util.List<java.lang.String>> getSeverityIdentification()
        Return the map of severity codes to severity names - if the audit log is set up correctly they should be 1-1. However, the audit log allows for components from different sources clashing on the severity code. The report helps an organization identify when this is occurring.
        Returns:
        map of severity codes to list of severity names associated with it.
      • setSeverityIdentification

        public void setSeverityIdentification​(java.util.Map<java.lang.Integer,​java.util.List<java.lang.String>> severityIdentification)
        Set up the map of severity codes to severity names - if the audit log is set up correctly they should be 1-1. However, the audit log allows for components from different sources clashing on the severity code. The report helps an organization identify when this is occurring.
        Parameters:
        severityIdentification - map of severity codes to list of severity names associated with it.
      • getSeverityCount

        public java.util.Map<java.lang.Integer,​java.lang.Integer> getSeverityCount()
        Return the count of log records for each severity code.
        Returns:
        map of severity code to log record count
      • setSeverityCount

        public void setSeverityCount​(java.util.Map<java.lang.Integer,​java.lang.Integer> severityCount)
        Set up the count of log records for each severity code.
        Parameters:
        severityCount - map of severity code to log record count
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Object
        Returns:
        JSON style description of variables.
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Validate that an object is equal depending on their stored values.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        objectToCompare - object
        Returns:
        boolean result
      • hashCode

        public int hashCode()
        Return a hash code based on the values of this object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        in hash code