All Superinterfaces:

BusinessKeyObject, NamedRootObject, NamedRootObjectComp, Readable, Root, SchedulerEntity, SchedulerEntityComp
```
public interface AuditRule
extends NamedRootObject, BusinessKeyObject, Readable
```
The rule for how objects should be audited.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`AUDITABLE_BUT_NOT_EXPORTABLE_OBJECTS`	List of objects that are auditable but not exportable.
`static String`	`OBJECT_TYPE`	String that will be returned from `SchedulerEntity.getObjectType()` for "AuditRule" objects.
`static String`	`SEC_PRIV_CREATE`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_DELETE`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_EDIT`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_VIEW`	This privilege can be granted at a group level.
`static String`	`SEC_RANK_ALL`	This rank is made of the following privileges: create , view , edit , delete
`static String`	`SEC_RANK_NONE`	This rank has no privileges assigned to it.
`static String`	`SEC_RANK_VIEW`	This rank is made of the following privileges: view
`static QueryObjectType<AuditRule>`	`TYPE`	Type that can be used in `SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)`.

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity
ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`RequiredPermission`	`checkCreatePrivilege()`	Check whether or not the create action can be performed on this object.
`RequiredPermission`	`checkDeletePrivilege()`	Check whether or not the delete action can be performed on this object.
`RequiredPermission`	`checkEditPrivilege()`	Check whether or not the edit action can be performed on this object.
`RequiredPermission`	`checkViewPrivilege()`	Check whether or not the view action can be performed on this object.
`Application`	`getApplication()`	Get the Application.
`ApplicationMatch`	`getApplicationRule()`	Get the value for ApplicationRule.
`AuditLevel`	`getLevel()`	Get the value for Level.
`String`	`getNamePattern()`	Get the value for NamePattern.
`AuditNameMatchType`	`getNamePatternMatchType()`	Get the value for NamePatternMatchType.
`Application`	`getParentApplication()`	Get the ParentApplication.
`String`	`getPartitionPattern()`	Get the value for PartitionPattern.
`AuditNameMatchType`	`getPartitionPatternMatchType()`	Get the value for PartitionPatternMatchType.
`String`	`getReasonRequiredRegEx()`	Deprecated. This attribute is no longer used
`String`	`getRuleObjectType()`	Get the value for RuleObjectType.
`boolean`	`isEnabled()`	Get the value for Enabled.
`boolean`	`isReasonRequired()`	Deprecated. This attribute is no longer used
`void`	`setApplication(Application newApplication)`	Set the value for Application.
`void`	`setApplicationRule(ApplicationMatch newApplicationRule)`	Set the value for ApplicationRule.
`void`	`setEnabled(boolean newEnabled)`	Set the value for Enabled.
`void`	`setLevel(AuditLevel newLevel)`	Set the value for Level.
`void`	`setNamePattern(String newNamePattern)`	Set the value for NamePattern.
`void`	`setNamePatternMatchType(AuditNameMatchType newNamePatternMatchType)`	Set the value for NamePatternMatchType.
`void`	`setParentApplication(Application newParentApplication)`	Set the value for ParentApplication.
`void`	`setPartitionPattern(String newPartitionPattern)`	Set the value for PartitionPattern.
`void`	`setPartitionPatternMatchType(AuditNameMatchType newPartitionPatternMatchType)`	Set the value for PartitionPatternMatchType.
`void`	`setReasonRequired(boolean newReasonRequired)`	Deprecated. This attribute is no longer used
`void`	`setReasonRequiredRegEx(String newReasonRequiredRegEx)`	Deprecated. This attribute is no longer used
`void`	`setRuleObjectType(String newRuleObjectType)`	Set the value for RuleObjectType.

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject
getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject
createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

Methods inherited from interface com.redwood.scheduler.api.model.Root
getCreationTime, getLastModificationTime, getLastModifierSubject

- Field Detail
  - OBJECT_TYPE
```
static final String OBJECT_TYPE
```
    String that will be returned from SchedulerEntity.getObjectType() for "AuditRule" objects.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
static final QueryObjectType<AuditRule> TYPE
```
    Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
  - AUDITABLE_BUT_NOT_EXPORTABLE_OBJECTS
```
static final String AUDITABLE_BUT_NOT_EXPORTABLE_OBJECTS
```
    List of objects that are auditable but not exportable.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_CREATE
```
static final String SEC_PRIV_CREATE
```
    This privilege can be granted at a group level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_VIEW
```
static final String SEC_PRIV_VIEW
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_EDIT
```
static final String SEC_PRIV_EDIT
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_DELETE
```
static final String SEC_PRIV_DELETE
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_NONE
```
static final String SEC_RANK_NONE
```
    This rank has no privileges assigned to it.
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_VIEW
```
static final String SEC_RANK_VIEW
```
    This rank is made of the following privileges: view
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_ALL
```
static final String SEC_RANK_ALL
```
    This rank is made of the following privileges: create , view , edit , delete
    
    See Also:
    
    Constant Field Values
- 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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.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:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getApplication
```
Application getApplication()
```
    Get the Application.
    
    Returns:
    
    Application
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
  - getParentApplication
```
Application getParentApplication()
```
    Get the ParentApplication.
    
    Returns:
    
    ParentApplication
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's 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.

Interface AuditRule

Field Summary

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

Method Summary

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject

Methods inherited from interface com.redwood.scheduler.api.model.Root

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

Field Detail

OBJECT_TYPE

TYPE

AUDITABLE_BUT_NOT_EXPORTABLE_OBJECTS

SEC_PRIV_CREATE

SEC_PRIV_VIEW

SEC_PRIV_EDIT

SEC_PRIV_DELETE

SEC_RANK_NONE

SEC_RANK_VIEW

SEC_RANK_ALL

Method Detail

getRuleObjectType

getLevel

isReasonRequired

getReasonRequiredRegEx

isEnabled

getApplicationRule

getNamePattern

getNamePatternMatchType

getPartitionPattern

getPartitionPatternMatchType

setRuleObjectType

setLevel

setReasonRequired

setReasonRequiredRegEx

setEnabled

setApplicationRule

setNamePattern

setNamePatternMatchType

setPartitionPattern

setPartitionPatternMatchType

getApplication

getParentApplication

setApplication

setParentApplication

checkCreatePrivilege

checkViewPrivilege

checkEditPrivilege

checkDeletePrivilege