Class AuditLogReportingComponent

  • All Implemented Interfaces:
    java.io.Serializable, ComponentDescription

    public class AuditLogReportingComponent
    extends java.lang.Object
    implements java.io.Serializable, ComponentDescription
    AuditLogReportingComponent describes the component issuing the audit log record.
    See Also:
    Serialized Form
    • Constructor Detail

      • AuditLogReportingComponent

        public AuditLogReportingComponent()
        Default constructor for Jackson
      • AuditLogReportingComponent

        public AuditLogReportingComponent​(ComponentDescription template)
        Copy/clone constructor
        Parameters:
        template - object to copy
      • AuditLogReportingComponent

        public AuditLogReportingComponent​(int componentId,
                                          ComponentDevelopmentStatus componentDevelopmentStatus,
                                          java.lang.String componentName,
                                          java.lang.String componentDescription,
                                          java.lang.String componentWikiURL)
        Construct the description of the reporting component.
        Parameters:
        componentId - numerical identifier for the component
        componentDevelopmentStatus - development status
        componentName - display name for the component
        componentDescription - description of the component
        componentWikiURL - link to more information
    • Method Detail

      • getComponentId

        public int getComponentId()
        Return the numerical code for this component.
        Specified by:
        getComponentId in interface ComponentDescription
        Returns:
        int componentId
      • setComponentId

        public void setComponentId​(int componentId)
        Set up the numerical code for this component.
        Parameters:
        componentId - int componentId
      • setComponentDevelopmentStatus

        public void setComponentDevelopmentStatus​(ComponentDevelopmentStatus componentDevelopmentStatus)
        Set up the development status of the component.
        Parameters:
        componentDevelopmentStatus - enum describing the status
      • getComponentName

        public java.lang.String getComponentName()
        Return the name of the component.
        Specified by:
        getComponentName in interface ComponentDescription
        Returns:
        String component name
      • setComponentName

        public void setComponentName​(java.lang.String componentName)
        Set up the name of the component.
        Parameters:
        componentName - String component name
      • getComponentType

        public java.lang.String getComponentType()
        Return the short description of the component. This is an English description. Natural language support for these values can be added to UIs using a resource bundle indexed with the component Id. This value is provided as a default if the resource bundle is not available.
        Specified by:
        getComponentType in interface ComponentDescription
        Returns:
        String description
      • setComponentDescription

        public void setComponentDescription​(java.lang.String componentDescription)
        Set up the short description of the component. This is an English description. Natural language support for these values can be added to UIs using a resource bundle indexed with the component Id. This value is provided as a default if the resource bundle is not available.
        Parameters:
        componentDescription - String description
      • getComponentWikiURL

        public java.lang.String getComponentWikiURL()
        Return the URL link to the wiki page that describes this component. This provides more information to the log reader on the operation of the component.
        Specified by:
        getComponentWikiURL in interface ComponentDescription
        Returns:
        String URL
      • setComponentWikiURL

        public void setComponentWikiURL​(java.lang.String componentWikiURL)
        Set up the URL link to the wiki page that describes this component. This provides more information to the log reader on the operation of the component.
        Parameters:
        componentWikiURL - string URL
      • 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