public interface IDfAuditTrailManager
Modifier and Type | Method and Description |
---|---|
IDfId |
createAudit(IDfId objectId,
java.lang.String event,
java.lang.String[] stringArgs,
IDfId[] idArgs)
Creates an audit trail entry for application events.
|
IDfList |
getAllEvents()
Gets a list of all the events(String) available in the repository.
|
IDfList |
getApplicableEvents(IDfId objectId)
Gets a list of applicable events(String) for the object.
|
IDfList |
getRegisteredEvents(IDfId objectId)
Gets a list of registered events(String) for the object.
|
IDfList |
getRegisteredEventsForType(java.lang.String typeName,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName)
Gets a list of registered events(String) for the object type.
|
boolean |
isEventAudited(IDfId objectId,
java.lang.String event)
Indicates if this event is currently being audited for the object.
|
boolean |
isEventAuditedForType(java.lang.String typeName,
java.lang.String event,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName)
Indicates if this event is currently being audited for the object type.
|
java.util.List<IDfPair<IDfId,java.lang.String>> |
parseBatchedIds(IDfId audittrailId)
Get a list of BatchAudit from an audittrail object.
|
void |
registerEvent(IDfId objectId,
java.lang.String event)
Registers an event for the object.
|
void |
registerEventForObject(IDfId objectId,
java.lang.String event,
boolean signAudit,
int authentication,
java.lang.String eventDescription,
IDfList attributeList)
Registers an event for object instance.
|
void |
registerEventForObjectEx(IDfId objectId,
java.lang.String event,
boolean signAudit,
int authentication,
java.lang.String eventDescription,
IDfList attributeList,
boolean eSignatureRequired)
Registers an event for object instance.
|
void |
registerEventForObjectEx2(IDfId objectId,
java.lang.String event,
boolean auditSubtypes,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName,
boolean signAudit,
int authentication,
java.lang.String eventDescription,
IDfList attributeList,
boolean eSignatureRequired)
Registers an event for object type.
|
void |
registerEventForType(java.lang.String typeName,
java.lang.String event,
boolean auditSubtypes,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName,
boolean signAudit,
int authentication,
java.lang.String eventDescription,
IDfList attributeList)
Registers an event for object type.
|
void |
registerEventForTypeEx(java.lang.String typeName,
java.lang.String event,
boolean auditSubtypes,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName,
boolean signAudit,
int authentication,
java.lang.String eventDescription,
IDfList attributeList,
boolean eSignatureRequired)
Registers an event for object type.
|
void |
registerEvents(IDfId objectId,
IDfList events)
Registers a list of events for the object.
|
void |
registerEventsFromQuery(java.lang.String query,
IDfList events)
Registers the events specified in IDflist for the objects returned by the query.
|
void |
registerEventsInFolder(IDfId folderId,
IDfList events)
Registers a list of events for all sysobjects under the folder.
|
void |
setRegisterEvents(IDfId objectId,
IDfList events)
Sets a list of events for the object.
|
void |
unregisterAllEvents(IDfId objectId)
Unregisters all events for the object.
|
void |
unregisterEvent(IDfId objectId,
java.lang.String event)
Unregisters an event for the object.
|
void |
unregisterEventForObject(IDfId objectId,
java.lang.String event,
IDfId policyId,
java.lang.String stateName)
Unregisters an event for the object type.
|
void |
unregisterEventForType(java.lang.String typeName,
java.lang.String event,
java.lang.String controllingApp,
IDfId policyId,
java.lang.String stateName)
Unregisters an event for the object type.
|
void |
unregisterEvents(IDfId objectId,
IDfList events)
Unregisters a list of events for the object.
|
void |
unregisterEventsFromQuery(java.lang.String query,
IDfList events)
For each object returned by the query, removes the registrations for the specified events.
|
void |
unregisterEventsInFolder(IDfId folderId,
IDfList events)
Unregisters a list of events for all sysobjects under the folder.
|
IDfList getAllEvents() throws DfException
DfException
IDfList getApplicableEvents(IDfId objectId) throws DfException
objectId
- Object Id of an object instance or object type that
can be audited. If this is an object instance, the
method gets its object type to determine
the applicable events. If null, the method returns all the available
events in the repository. If the object id does not represent
an auditable entity, the method returns an empty list.DfException
boolean isEventAudited(IDfId objectId, java.lang.String event) throws DfException
objectId
- Object Id of an object instance or object type that
can be audited. If null, the method tests if the event is audited
for the whole repository.event
- Name of the event.DfException
boolean isEventAuditedForType(java.lang.String typeName, java.lang.String event, java.lang.String controllingApp, IDfId policyId, java.lang.String stateName) throws DfException
typeName
- The name of the type.event
- Name of the event.controllingApp
- Name of the application that controls this object. This parameter allows
you to turn on auditing only when the object is controlled by this
application.
If it is set to null, the method tests for the existence of an object
type event registration that is not controlled by any application.policyId
- Object id of a dm_policy object. This parameter allows you to turn on
auditing only when the object instance is controlled by this policy.
If it is set to null, the method tests for the existence of an object
type event registration that is not controlled by any policy.stateName
- Name of the policy state that allows you to turn on auditing only
when the object instance is in a particular state in the policy.
This parameter is ignored if policyId is null.DfException
void registerEvent(IDfId objectId, java.lang.String event) throws DfException
objectId
- Object ID of the object or type. null if this is
for the whole repository. If this is an object type,
it behaves the same as registerEventForType with null controllingApp and policyId.event
- Name of the event.DfException
void registerEventForType(java.lang.String typeName, java.lang.String event, boolean auditSubtypes, java.lang.String controllingApp, IDfId policyId, java.lang.String stateName, boolean signAudit, int authentication, java.lang.String eventDescription, IDfList attributeList) throws DfException
typeName
- The name of an object type.event
- Name of the event.auditSubtypes
- Indicates if subtypes should also be audited.controllingApp
- Name of the application that controls this object. This parameter allows you
to turn on auditing only when the object instance is controlled by this
application.
If the event is dm_all_workflow or dm_all, do not use this parameter.
Including it will cause an exception to be thrown.
If it is set to null, this parameter is ignored.policyId
- Object ID of a dm_policy object. This parameter allows you to turn on
auditing only when the object instance is controlled by this policy.
If it is set to null, this parameter is ignored.
If the event is dm_all_workflow or dm_all, do not use this parameter.
Including it will cause an exception to be thrown.stateName
- Name of the policy state that allows you to turn on auditing only
when the object instance is in a particular state in the policy.
If policy id is set to null, this parameter is ignored.
If the event is dm_all_workflow, this parameter should not be used.
Otherwise, an exception is thrown.signAudit
- Defines whether the audit records created need to be signed. The default
is false if not specified.authentication
- Specify if an application must authenticate the user or
require a signature before the event.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.eventDescription
- Specify a user-friendly description of the event.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.attributeList
- A list of attributes of the type that should be included
in each audit record.
If typeName is dm_process, this must contain attributes of
dm_workflow.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.DfException
void registerEventForTypeEx(java.lang.String typeName, java.lang.String event, boolean auditSubtypes, java.lang.String controllingApp, IDfId policyId, java.lang.String stateName, boolean signAudit, int authentication, java.lang.String eventDescription, IDfList attributeList, boolean eSignatureRequired) throws DfException
typeName
- The name of an object type.event
- Name of the event.auditSubtypes
- Indicates if subtypes should also be audited.controllingApp
- Name of the application that controls this object. This parameter allows
you to turn on auditing only when the object instance is controlled by this
application.
If the event is dm_all_workflow or dm_all, do not use this parameter.
Including it will cause an exception to be thrown.
If it is set to null, this parameter is ignored.policyId
- Object id of a dm_policy object. This parameter allows you to turn on
auditing only when the object instance is controlled by this policy.
If it is set to null, this parameter is ignored.
If the event is dm_all_workflow or dm_all, do not use this parameter.
Including it will cause an exception to be thrown.stateName
- Name of the policy state allows you to turn on auditing only
when the object instance is in a particular state in the policy.
If policy id is set to null, this parameter is ignored.
If the event is dm_all_workflow, this parameter should not be used.
Otherwise, an exception is thrown.signAudit
- Defines if the audit records that will be created to be signed.
The default is false if not specified.authentication
- Specify if an application must authenticate the user or
require a signature before the event.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.eventDescription
- Specify a user-friendly description of the event.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.attributeList
- A list of attributes of the type that should be included
in each audit record.
If typeName is dm_process, this must contain attributes of
dm_workflow.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.eSignatureRequired
- Spefifies whether the event requires electronic signatureDfException
void registerEventForObject(IDfId objectId, java.lang.String event, boolean signAudit, int authentication, java.lang.String eventDescription, IDfList attributeList) throws DfException
objectId
- Object id of an object instance.event
- Name of the event.signAudit
- Whether the audit records for the event must be signed by the server.authentication
- Whether an application must authenticate the user before creating
the audit trail entry for the event.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.eventDescription
- Specify a user-friendly description of the event.
If the event is dm_all, this parameter should not be used.
Including it will cause an exception to be thrown.attributeList
- A list attribute names from the object's type to be included
in each audit record.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.DfException
void registerEventForObjectEx(IDfId objectId, java.lang.String event, boolean signAudit, int authentication, java.lang.String eventDescription, IDfList attributeList, boolean eSignatureRequired) throws DfException
objectId
- Object id of an object instance.event
- Name of the event.signAudit
- Whether the audit records for the event must be signed by the server.authentication
- Whether an application must authenticate the user before creating
the audit trail entry for the event.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.eventDescription
- Specify a user-friendly description of the event.
If the event is dm_all, this parameter should not be used.
Including it will cause an exception to be thrown.attributeList
- A list attribute names from the object's type to be included
in each audit record.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.eSignatureRequired
- Spefifies whether the event requires electronic signatureDfException
void registerEventForObjectEx2(IDfId objectId, java.lang.String event, boolean auditSubtypes, java.lang.String controllingApp, IDfId policyId, java.lang.String stateName, boolean signAudit, int authentication, java.lang.String eventDescription, IDfList attributeList, boolean eSignatureRequired) throws DfException
objectId
- Object id of an object instance.event
- Name of the event.auditSubtypes
- Indicates if subtypes should also be audited.controllingApp
- Name of the application that controls this object. This parameter
allows you to turn on auditing only when the object instance is controlled by this
application.
If the event is dm_all_workflow or dm_all, do not use this parameter.
Including it will cause an exception to be thrown.
If it is set to null, this parameter is ignored.policyId
- Object id of a dm_policy object. This parameter allows you to turn on
auditing only when the object instance is controlled by this policy.
If it is set to null, this parameter is ignored.
If the event is dm_all_workflow or dm_all, do not use this parameter.
Including it will cause an exception to be thrown.stateName
- Name of the policy state that allows you to turn on auditing only
when the object instance is in a particular state in the policy.
If policy id is set to null, this parameter is ignored.
If the event is dm_all_workflow, this parameter should not be used.
Otherwise, an exception is thrown.signAudit
- Defines whether the audit records created need to be signed.
The default is false.authentication
- Specify whether an application must authenticate the user or
require a signature before the event.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.eventDescription
- Specify a user-friendly description of the event.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.attributeList
- A list of attributes of the type that should be included
in each audit record.
If typeName is dm_process, this must contain attributes of
dm_workflow.
If the event is dm_all, do not use this parameter.
Including it will cause an exception to be thrown.eSignatureRequired
- Spefifies whether the event requires electronic signatureDfException
void registerEvents(IDfId objectId, IDfList events) throws DfException
objectId
- The object Id of the object or type. null if this is
for the whole repository.events
- A list of events.DfException
void registerEventsFromQuery(java.lang.String query, IDfList events) throws DfException
query
- The query to be run.
For example: dm_sysobject where object_name='foo'events
- A list of events.DfException
void registerEventsInFolder(IDfId folderId, IDfList events) throws DfException
folderId
- The object id of the folder.events
- A list of eventsDfException
void setRegisterEvents(IDfId objectId, IDfList events) throws DfException
objectId
- The object id of the object or type. null if this is for the
whole repository.events
- A list of events.DfException
IDfList getRegisteredEvents(IDfId objectId) throws DfException
objectId
- Object Id of an object instance or object type that
can be audited. If null, the method returns the events audited
for the whole repository. If this represents an object type,
the method behaves the same as getRegisteredEventsForType with
no controllingApp and policy information.DfException
IDfList getRegisteredEventsForType(java.lang.String typeName, java.lang.String controllingApp, IDfId policyId, java.lang.String stateName) throws DfException
typeName
- The name of the object typecontrollingApp
- The name of the application that controls this object. This parameter
allows you to turn on auditing only when the object instance is controlled by
this application.
If it is set to null, the method tests for existence of object type event
registration with no controlling application.policyId
- Object id of a dm_policy object. This parameter allows you to turn on
auditing only when the object is controlled by this policy.
If it is set to null, the method tests for existence of object type event
registration with no policy information.stateName
- Name of the policy state allows you to turn on auditing only
when the object is in a particular state in the policy.
This parameter is ignored if policyId is null.DfException
void unregisterEvent(IDfId objectId, java.lang.String event) throws DfException
objectId
- The object ID of the object or type. null if this is
for the whole repository. If this represents an object type,
the method behaves the same as unregisterEventForType with no
controlling app and policy information.event
- The name of the event.DfException
void unregisterEventForObject(IDfId objectId, java.lang.String event, IDfId policyId, java.lang.String stateName) throws DfException
objectId
- The object ID of the object or type. null if this is
for the whole repository. If this represents an object type,
the method behaves the same as unregisterEventForType with no
controlling app and policy information.event
- The name of the event.policyId
- Object ID of a dm_policy object. This parameter allows you to turn on
auditing only when the object is controlled by this policy.
If it is set to null, the method tests for existence of object type event
registration with no policy information.
If event is dm_all_workflow, do not use this parameter.stateName
- Name of the policy state allows you to turn on auditing only
when the object is in a particular state in the policy.
This parameter is ignored if policyId is null.DfException
void unregisterEventForType(java.lang.String typeName, java.lang.String event, java.lang.String controllingApp, IDfId policyId, java.lang.String stateName) throws DfException
typeName
- The name of the object typeevent
- The name of the event.controllingApp
- Name of the application that controls this object. This parameter allows
you to turn on auditing only when the object instance is controlled by this
application.
If event is dm_all_workflow, do not use this parameter.
If it is set to null, the method tests for the existence of an object type
event registration with no controlling application.policyId
- Object id of a dm_policy object. This parameter allows you to turn on
auditing only when the object is controlled by this policy.
If it is set to null, the method tests for the existence of object type
event registration with no policy information.
If event is dm_all_workflow, do not use this parameter.stateName
- Name of a policy state; allows you to turn on auditing only when the
object is in a particular state in the policy.
This parameter is ignored if policyId is null.DfException
void unregisterEvents(IDfId objectId, IDfList events) throws DfException
objectId
- The object ID of the object or type. null if this is
for the whole repository.events
- A list of events.DfException
void unregisterEventsFromQuery(java.lang.String query, IDfList events) throws DfException
query
- The query to be run to retrieve the objects from which to
remove the event registrations.
For example: dm_sysobject where object_name='foo'events
- A list of events.DfException
void unregisterEventsInFolder(IDfId folderId, IDfList events) throws DfException
folderId
- The object ID of the folder.events
- A list of eventsDfException
void unregisterAllEvents(IDfId objectId) throws DfException
objectId
- The object ID of the object instance of type.
If null, it represents the whole repository.DfException
IDfId createAudit(IDfId objectId, java.lang.String event, java.lang.String[] stringArgs, IDfId[] idArgs) throws DfException
objectId
- Identifies the object of the audited event. Use the object's object ID.event
- Identities the audited event. Use the event's name.stringArgs
- Array of up to 5 additional string argumentsidArgs
- Array of up to 5 additional ID argumentsDfException
java.util.List<IDfPair<IDfId,java.lang.String>> parseBatchedIds(IDfId audittrailId) throws DfException
audittrailId
- The dm_batch_auditrail object idDfException
- if the object is not a dm_audittrailCopyright 1994-2023 OpenText Corporation. All rights reserved.