Package com.redwood.scheduler.api.model

Interface AuditObject

    • Method Detail

      • getAuditedObjectType

        String getAuditedObjectType()
        Get the value for AuditedObjectType. (The type of the object that's change is being recorded.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getAuditedObjectUniqueId

        Long getAuditedObjectUniqueId()
        Get the value for AuditedObjectUniqueId. (The unique id of the object that's change is being recorded.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getAuditedObjectBusinessKey

        String getAuditedObjectBusinessKey()
        Get the value for AuditedObjectBusinessKey. (The business key of the object that's change is being recorded.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getAuditedObjectPartitionUniqueId

        Long getAuditedObjectPartitionUniqueId()
        Get the value for AuditedObjectPartitionUniqueId. (Unique id of partition of audited object.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getAuditedObjectPartition

        Partition getAuditedObjectPartition()
        Get the value for AuditedObjectPartition. (Partition (based on AuditedObjectPartitionUniqueId) or null)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getAuditedObjectPartitionName

        String getAuditedObjectPartitionName()
        Get the value for AuditedObjectPartitionName. (Partition name of audited object or null.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getSearchAuditedObjectBusinessKey

        String getSearchAuditedObjectBusinessKey()
        Get the value for SearchAuditedObjectBusinessKey. (The search form of the business key of the object that's change is being recorded.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getUser

        String getUser()
        Get the value for User. (The user that made the change.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getSearchUser

        String getSearchUser()
        Get the value for SearchUser. (The search form of the user.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getAction

        ModelChangeAction getAction()
        Get the value for Action. (The action that was performed, be that create, modify or delete.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getLevel

        AuditLevel getLevel()
        Get the value for Level. (The level of auditing that is recorded for the object.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getAdditionalInfo

        String getAdditionalInfo()
        Get the value for AdditionalInfo. (Additional information about the change.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getSearchAdditionalInfo

        String getSearchAdditionalInfo()
        Get the value for SearchAdditionalInfo. (The search form of the additional information.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getDiff

        String getDiff()
        Get the value for Diff. (The full text of the AuditObject diff.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getOldObjectDef

        String getOldObjectDef()
        Get the value for OldObjectDef. (The full XML of the Audited Object definition before the audited change was made.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getNewObjectDef

        String getNewObjectDef()
        Get the value for NewObjectDef. (The full XML of the Audited Object definition after the audited change was made.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getDiffText

        String getDiffText()
        Get the Audit Diff value as a text version.
        Returns:
        The audit diff in text format

      • hasOldObjectDef

        boolean hasOldObjectDef()
        An efficient way to determine whether OldObjectDef exists.
        Returns:
        true when OldObjectDef exists

      • hasNewObjectDef

        boolean hasNewObjectDef()
        An efficient way to determine whether NewObjectDef exists.
        Returns:
        true when NewObjectDef exists

      • getReason

        @Deprecated
String getReason()
        Deprecated.
        This method is deprecated, it was never used.

        The optional reason for why the change was made. This method as been deprecated as it was never used.

        Returns:
        Return the reason why the change was made

      • getSearchReason

        @Deprecated
String getSearchReason()
        Deprecated.
        This method is deprecated, it was never used.

        The search form of the reason. This method as been deprecated as it was never used.

        Returns:
        Return the reason why the change was made in search form

      • restoreBefore

        void restoreBefore()
        Restore an audited object from the archived value before the audited change was made.

      • restoreAfter

        void restoreAfter()
        Restore an audited object from the archived value after the audited change was made.

      • checkViewPrivilege

        RequiredPermission checkViewPrivilege()
        Check whether or not the view action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkCreatePrivilege

        RequiredPermission checkCreatePrivilege()
        Check whether or not the create action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkEditPrivilege

        RequiredPermission checkEditPrivilege()
        Check whether or not the edit action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkDeletePrivilege

        RequiredPermission checkDeletePrivilege()
        Check whether or not the delete action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkRestorePrivilege

        RequiredPermission checkRestorePrivilege()
        Check whether or not the restore action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.