Table Of Contents

AuditTrail Management Functions

AuditTrailRecords

readAuditTrailRecords

AuditTrail Management Functions

---

This chapter provides information about the following audit trail management functions:

•AuditTrailRecords

•readAuditTrailRecords

AuditTrailRecords

Synopsis

Status purgeAuditTrailRecords(UserToken token, int numToKeep) throws RemoteException;

Description

This function purges the audit trail logs that contain records of user activities. It removes the older records that exceed the numToKeep parameter.

Input Parameters

Parameter	Type	Value	Description
token	UserToken, mandatory	—	A token that represents your authorization pass, which is obtained after you invoke the login function and are authenticated by the back-end server.
numToKeep	Integer, mandatory	Valid integer value	The number (quantity) of the log records to keep.

Return

This function returns a Status object.

Error and Exception

If a system error prevents the operation from completing, a RemoteException is thrown.

When an error occurs, the Status object returns the none SUCCESS error code and error message.

readAuditTrailRecords

Synopsis

AuditTrail[] readAuditTrailRecords(UserToken token, int numRecords) throws 
RemoteException;

Description

This function retrieves the audit trail logs that contain records of user activities. If numRecords is set to 0, it returns all records in the system.

Input Parameters

Parameter	Type	Value	Description
token	UserToken, mandatory	—	A token that represents your authorization pass, which is obtained after you invoke the login function and are authenticated by the back-end server.
numRecords	Integer, mandatory	Valid integer value	The number (quantity) of the log records to keep.

Return

This function returns an array of AuditTrail objects.

Error and Exception

If a system error prevents the operation from completing, a RemoteException is thrown.

When an error occurs, this function returns null. An array of length zero indicates that no record was found.