public class AuditEventTypeDefinition extends Object
Constructor and Description |
---|
AuditEventTypeDefinition(String opTypeKey,
int targetCode,
String targetClassName,
int opCode)
Constructs an AuditEventTypeDefinition,
that is neither a create or free operation.
|
AuditEventTypeDefinition(String opTypeKey,
int targetCode,
String targetClassName,
int opCode,
Boolean createOrFree)
Constructs an AuditEventTypeDefinition
|
Modifier and Type | Method and Description |
---|---|
static int |
calculateOperationType(int targetCode,
int opCode)
Calculate a numeric Operation type from a target code and
operation code.
|
Boolean |
getCreateOrFreeIndication()
Returns indication as to whether the event type a create or free event?
|
int |
getOperationCode()
Gets the numeric repesentation of the operation code.
|
int |
getOperationType()
Gets the numeric repesentation of the operation type, a combination of
the target code and the operation code.
|
String |
getOperationTypeKey()
Gets the String key repesentation of the operation type.
|
String |
getTargetClassName()
Gets the Name of the target ClassObject.
|
int |
getTargetCode()
Gets the numerical target code.
|
boolean |
register(LibrarySession session)
Register the Audit event type defined by this instance.
|
public AuditEventTypeDefinition(String opTypeKey, int targetCode, String targetClassName, int opCode)
opTypeKey
- the String operation type key
(e.g. "DOCUMENT_CREATED")targetCode
- the enumerated int representing the target code
(e.g. 32 for ActivityRecord)targetClassName
- the name of the target class
(e.g. "FOLDER")opCode
- the enumerated int representing the code
for the operation (e.g. 25 for "LOCKED")public AuditEventTypeDefinition(String opTypeKey, int targetCode, String targetClassName, int opCode, Boolean createOrFree)
opTypeKey
- the String operation type key
(e.g. "DOCUMENT_CREATED")targetCode
- the enumerated int representing the target code
(e.g. 32 for ActivityRecord)targetClassName
- the name of the target class
(e.g. "FOLDER")opCode
- the enumerated int representing the code
for the operation (e.g. 25 for "LOCKED")createOrFree
- True, False, or null Boolean used to
indicate whether the operation reflects a
create or free operation;
True indicates a create operation;
False indicates a free operation;
null indicates neither a create nor free operationpublic String getOperationTypeKey()
For example, "DOCUMENT_CREATED" (see AuditEventTypes)
public int getTargetCode()
For example, 4 when the target is a Folder (see AuditEventCodes)
public String getTargetClassName()
For example, "FOLDER" when the target's ClassObject is Folder.
public int getOperationCode()
For example, 25 for the "LOCKED" operation (see AuditEventCodes)
public Boolean getCreateOrFreeIndication()
True indicates a create operation; False indicates a free operation; null indicates neither a create nor a free operation.
public int getOperationType()
Calculated assuming 999999 is the highest operation code. For example, the operation type for the "FOLDER_LOCKED" operation is calculated to be 4000025. See utility method calculateOperationType().
public boolean register(LibrarySession session) throws IfsException
Skip registration attempt if the event is already registered.
session
- the session contextIfsException
- if the operation failspublic static int calculateOperationType(int targetCode, int opCode)
targetCode
- target codeopCode
- operation codeCopyright © 2023. All rights reserved.