Package com.redwood.scheduler.api.model

Interface AuditRule

    • Method Detail

      • getRuleObjectType

        String getRuleObjectType()
        Get the value for RuleObjectType. (The type of object the rule applies to.) 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 the audit log to keep for the object type) 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.

      • isReasonRequired

        @Deprecated
boolean isReasonRequired()
        Deprecated.
        This attribute is no longer used

        Get the value for ReasonRequired. (Deprecated attribute, do not use. Is a reason required for audit record)

        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getReasonRequiredRegEx

        @Deprecated
String getReasonRequiredRegEx()
        Deprecated.
        This attribute is no longer used

        Get the value for ReasonRequiredRegEx. (Deprecated attribute, do not use. The regular expression for filtering the required reason)

        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isEnabled

        boolean isEnabled()
        Get the value for Enabled. (Enable/disable the audit rule)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getApplicationRule

        ApplicationMatch getApplicationRule()
        Get the value for ApplicationRule. (Rule for the Application match.) 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.

      • getNamePattern

        String getNamePattern()
        Get the value for NamePattern. (Pattern for the Name of the Audited object.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getNamePatternMatchType

        AuditNameMatchType getNamePatternMatchType()
        Get the value for NamePatternMatchType. (The type of pattern match for the Name of the 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.

      • getPartitionPattern

        String getPartitionPattern()
        Get the value for PartitionPattern. (Pattern for the Partition of the Audited object.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getPartitionPatternMatchType

        AuditNameMatchType getPartitionPatternMatchType()
        Get the value for PartitionPatternMatchType. (The type of pattern match for the Partition of the 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.

      • setRuleObjectType

        void setRuleObjectType​(String newRuleObjectType)
        Set the value for RuleObjectType. (The type of object the rule applies to.) This value is mandatory.
        Parameters:
        newRuleObjectType - the new value for RuleObjectType. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setLevel

        void setLevel​(AuditLevel newLevel)
        Set the value for Level. (The level of the audit log to keep for the object type) This value is mandatory.
        Parameters:
        newLevel - the new value for Level. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setReasonRequired

        @Deprecated
void setReasonRequired​(boolean newReasonRequired)
        Deprecated.
        This attribute is no longer used

        Set the value for ReasonRequired. (Deprecated attribute, do not use. Is a reason required for audit record)

        Parameters:
        newReasonRequired - the new value for ReasonRequired.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setReasonRequiredRegEx

        @Deprecated
void setReasonRequiredRegEx​(String newReasonRequiredRegEx)
        Deprecated.
        This attribute is no longer used

        Set the value for ReasonRequiredRegEx. (Deprecated attribute, do not use. The regular expression for filtering the required reason) This value is optional.

        Parameters:
        newReasonRequiredRegEx - the new value for ReasonRequiredRegEx.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setEnabled

        void setEnabled​(boolean newEnabled)
        Set the value for Enabled. (Enable/disable the audit rule)
        Parameters:
        newEnabled - the new value for Enabled.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setApplicationRule

        void setApplicationRule​(ApplicationMatch newApplicationRule)
        Set the value for ApplicationRule. (Rule for the Application match.) This value is mandatory.
        Parameters:
        newApplicationRule - the new value for ApplicationRule. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setNamePattern

        void setNamePattern​(String newNamePattern)
        Set the value for NamePattern. (Pattern for the Name of the Audited object.) This value is optional.
        Parameters:
        newNamePattern - the new value for NamePattern.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setNamePatternMatchType

        void setNamePatternMatchType​(AuditNameMatchType newNamePatternMatchType)
        Set the value for NamePatternMatchType. (The type of pattern match for the Name of the Audited object.) This value is mandatory.
        Parameters:
        newNamePatternMatchType - the new value for NamePatternMatchType. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setPartitionPattern

        void setPartitionPattern​(String newPartitionPattern)
        Set the value for PartitionPattern. (Pattern for the Partition of the Audited object.) This value is optional.
        Parameters:
        newPartitionPattern - the new value for PartitionPattern.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setPartitionPatternMatchType

        void setPartitionPatternMatchType​(AuditNameMatchType newPartitionPatternMatchType)
        Set the value for PartitionPatternMatchType. (The type of pattern match for the Partition of the Audited object.) This value is mandatory.
        Parameters:
        newPartitionPatternMatchType - the new value for PartitionPatternMatchType. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setApplication

        void setApplication​(Application newApplication)
        Set the value for Application. This value is optional.
        Parameters:
        newApplication - is the object to set Application to. The optional Application for an AuditRule.

      • setParentApplication

        void setParentApplication​(Application newParentApplication)
        Set the value for ParentApplication. This value is optional.
        Parameters:
        newParentApplication - is the object to set ParentApplication to. Audits rule can be group descendants of ApplicationObject.

      • 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.

      • 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.

      • 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.