FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface AuditDefinition

All Superinterfaces:
java.io.Serializable

public interface AuditDefinition
extends java.io.Serializable

Not Implemented in CS Java Connector v3.0.

An AuditDefinition object represents an audit event that is defined for a class, and includes configuration information that describes how to audit the event. This information includes:

Audit definitions are created either through the Content Services Enterprise Manager tool or via the Content COM API. For each event that is to be audited for a class, an AuditDefinition object is added to the class's definition list.

You cannot create a new AuditDefinition object via the Content Services Java Connector , but you can instantiate an existing one by calling the getAuditDefinitions(incInherited) method on a ClassDescription object, then retrieving an AuditDefinition object from the returned collection. The collection contains the audit definitions defined for the class.


Method Summary
 boolean getAuditFailure()
          

Not Implemented in CS Java Connector v3.0.

 boolean getAuditSuccess()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getClassId()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getEventClassId()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getId()
          

Not Implemented in CS Java Connector v3.0.

 boolean getIncludeSubclassesRequested()
          

Not Implemented in CS Java Connector v3.0.

 

Method Detail

getId

public java.lang.String getId()

Not Implemented in CS Java Connector v3.0.

Returns a string that represents the Globally Unique Identifier (GUID) of this AuditDefinition object. The Content Services server assigns each object a universally-unique GUID that cannot be changed.

Returns:
A String representing the GUID of this AuditDefinition object.

getClassId

public java.lang.String getClassId()

Not Implemented in CS Java Connector v3.0.

Returns a string that represents the Globally Unique Identifier (GUID) of this AuditDefinition object's ClassDescription object.

All Content Services objects have a class. Each class is identified by a universally-unique GUID, which is system-assigned when the class is created.

Returns:
A String representing the GUID of this AuditDefinition object's class.

getAuditFailure

public boolean getAuditFailure()

Not Implemented in CS Java Connector v3.0.

For a system-generated audit event, specifies whether this AuditDefinition object is configured to audit failed operations. Applications that generate custom audit events can choose to interpret the return value of the getAuditFailure method as desired.

Returns:
true if auditing for failed operations is enabled for this AuditDefinition object, otherwise false.

getAuditSuccess

public boolean getAuditSuccess()

Not Implemented in CS Java Connector v3.0.

For a system-generated audit event, specifies whether this AuditDefinition object is configured to audit successful operations. Applications that generate custom audit events can choose to interpret the return value of the getAuditSuccess method as desired.

Returns:
true if auditing for successful operations is enabled for this AuditDefinition object, otherwise false.

getEventClassId

public java.lang.String getEventClassId()

Not Implemented in CS Java Connector v3.0.

Returns a string that represents the Globally Unique Identifier (GUID) of the class definition for the Event class (such as CheckinEvent) that is enabled for this AuditDefinition object.

Returns:
A String representing the GUID of the class definition for the Event class that is enabled for this AuditDefinition object.

getIncludeSubclassesRequested

public boolean getIncludeSubclassesRequested()

Not Implemented in CS Java Connector v3.0.

Specifies whether this AuditDefinition object is configured to audit the subclasses of the containing class for this AuditDefinition object. For example, assume this AuditDefinition object is defined for the class, MyDocumentClass. If the getIncludeSubclassesRequested method returnes true, then any subclasses of MyDocumentClass will also be audited.

Returns:
true if auditing is inherited by the subclasses of the containing class for this AuditDefinition object, otherwise false.

FileNet Content Services
Java Connector v3.0