Package com.jk.core.security

Class JKAudit

java.lang.Object
com.jk.core.security.JKAudit
public class JKAudit extends Object
This class is used to represents an audit entry that tracks changes made to a business record.
Version:
1.0
Author:
Dr. Jalal H. Kiswani

  • Constructor Summary

    Constructors
    Constructor
    Description
    JKAudit()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAuditId()
    This method gets the unique identifier for the audit entry.
    String
    getAuditText()
    This method generates an audit text representation that combines the previous and new values for the changed data, separated by a divider.
    JKAuditType
    getAuditType()
    This method gets the type of audit.
    Object
    getBusinessRecordId()
    This method gets the identifier of the business record associated with the audit entry.
    Date
    getDate()
    This method gets the date and time when the audit entry was created.
    String
    getDescription()
    This method get the description of the change made.
    String
    getGui()
    This method gets the graphical user interface (GUI).
    String
    getNewValue()
    This method gets the new value of the changed data.
    String
    getOldValue()
    This method gets the previous value of the changed data.
    String
    getTableName()
    This method gets the name of the database table where the change occurred.
    JKUser
    getUser()
    This method gets the user associated with the audit entry.
    void
    setAuditId(int auditId)
    This method sets the unique identifier for the audit entry to the provided value.
    void
    setAuditType(JKAuditType auditType)
    This method sets the type of audit to the provided value.
    void
    setBusinessRecordId(Object businessRecordId)
    This method sets the identifier of the business record associated with the audit entry to the provided value.
    void
    setDate(Date date)
    This method sets the date and time when the audit entry was created to the provided value.
    void
    setDescription(String description)
    This method sets the description of the change made to the provided value.
    void
    setGui(Object gui)
    This method sets the graphical user interface (GUI) to the provided value.
    void
    setGui(String gui)
    This method sets the graphical user interface (GUI) to the provided value.
    void
    setNewValue(String newValue)
    This method sets the new value of the changed data to the provided value.
    void
    setOldValue(String oldValue)
    This method sets the previous value of the changed data to the provided value.
    void
    setTableName(String recordName)
    This method sets the name of the database table where the change occurred to the provided value.
    void
    setUser(JKUser user)
    This method sets the user associated with the audit entry to the provided value.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • JKAudit

      public JKAudit()

  • Method Details

    • getAuditId

      public int getAuditId()
      This method gets the unique identifier for the audit entry.
      Returns:
      the unique identifier for the audit entry.

    • getAuditText

      public String getAuditText()
      This method generates an audit text representation that combines the previous and new values for the changed data, separated by a divider.
      Returns:
      The audit text representation.

    • getAuditType

      public JKAuditType getAuditType()
      This method gets the type of audit.
      Returns:
      the audit type.

    • getBusinessRecordId

      public Object getBusinessRecordId()
      This method gets the identifier of the business record associated with the audit entry.
      Returns:
      the identifier of the business record associated with the audit entry.

    • getDate

      public Date getDate()
      This method gets the date and time when the audit entry was created.
      Returns:
      the date and time when the audit entry was created.

    • getDescription

      public String getDescription()
      This method get the description of the change made.
      Returns:
      the description of the change made.

    • getGui

      public String getGui()
      This method gets the graphical user interface (GUI).
      Returns:
      the graphical user interface (GUI).

    • getNewValue

      public String getNewValue()
      This method gets the new value of the changed data.
      Returns:
      the new value of the changed data.

    • getOldValue

      public String getOldValue()
      This method gets the previous value of the changed data.
      Returns:
      the previous value of the changed data.

    • getTableName

      public String getTableName()
      This method gets the name of the database table where the change occurred.
      Returns:
      the name of the database table where the change occurred.

    • getUser

      public JKUser getUser()
      This method gets the user associated with the audit entry.
      Returns:
      the user associated with the audit entry.

    • setAuditId

      public void setAuditId(int auditId)
      This method sets the unique identifier for the audit entry to the provided value.
      Parameters:
      auditId - Specifies the new unique identifier for the audit entry.

    • setAuditType

      public void setAuditType(JKAuditType auditType)
      This method sets the type of audit to the provided value.
      Parameters:
      auditType - Specifies the new audit type.

    • setBusinessRecordId

      public void setBusinessRecordId(Object businessRecordId)
      This method sets the identifier of the business record associated with the audit entry to the provided value.
      Parameters:
      businessRecordId - Specifies the new identifier of the business record associated with the audit entry.

    • setDate

      public void setDate(Date date)
      This method sets the date and time when the audit entry was created to the provided value.
      Parameters:
      date - Specifies the new date and time when the audit entry was created.

    • setDescription

      public void setDescription(String description)
      This method sets the description of the change made to the provided value.
      Parameters:
      description - Specifies the new description of the change made.

    • setGui

      public void setGui(Object gui)
      This method sets the graphical user interface (GUI) to the provided value.
      Parameters:
      gui - Specifies the new graphical user interface (GUI).

    • setGui

      public void setGui(String gui)
      This method sets the graphical user interface (GUI) to the provided value.
      Parameters:
      gui - Specifies the new graphical user interface (GUI).

    • setNewValue

      public void setNewValue(String newValue)
      This method sets the new value of the changed data to the provided value.
      Parameters:
      newValue - Specifies the new value of the changed data.

    • setOldValue

      public void setOldValue(String oldValue)
      This method sets the previous value of the changed data to the provided value.
      Parameters:
      oldValue - Specifies the new previous value of the changed data.

    • setTableName

      public void setTableName(String recordName)
      This method sets the name of the database table where the change occurred to the provided value.
      Parameters:
      recordName - Specifies the new name of the database table where the change occurred.

    • setUser

      public void setUser(JKUser user)
      This method sets the user associated with the audit entry to the provided value.
      Parameters:
      user - Specifies the new user associated with the audit entry.