com.filenet.api.admin
Interface AuditDefinition

All Superinterfaces:
DependentObject, EngineObject, RepositoryObject, java.io.Serializable

public interface AuditDefinition
extends RepositoryObject, EngineObject, DependentObject

Represents a definition that specifies audit-event parameters. Audit events are set on a per-class basis: use this interface to configure a SubscribableClassDefinition object or subobject for auditing. Create an AuditDefinition object for each event that you want to audit for the class.

To create an AuditDefinition object, call the createInstance method on the Factory.AuditDefinition class. Once created, set its properties, which define the event to be audited and other parameters.

For each AuditDefinition object that you create, add it to an AuditDefinitionList collection, then set the collection on the SubscribableClassDefinition object.

To retrieve AuditDefinition objects, get the AuditDefinitionList collection and iterate it.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: ObjectStore
SuperclassName: GenericObject


Method Summary
 java.lang.Boolean get_AuditFailure()
          Returns the value of the AuditFailure property.
 java.lang.Boolean get_AuditSuccess()
          Returns the value of the AuditSuccess property.
 EventClassDefinition get_EventClass()
          Returns the value of the EventClass property.
 Id get_Id()
          Returns the value of the Id property.
 java.lang.Boolean get_IncludeSubclassesRequested()
          Returns the value of the IncludeSubclassesRequested property.
 ObjectStateRecordingLevel get_ObjectStateRecordingLevel()
          Returns the value of the ObjectStateRecordingLevel property.
 void set_AuditFailure(java.lang.Boolean value)
          Sets the value of the AuditFailure property.
 void set_AuditSuccess(java.lang.Boolean value)
          Sets the value of the AuditSuccess property.
 void set_EventClass(EventClassDefinition value)
          Sets the value of the EventClass property.
 void set_IncludeSubclassesRequested(java.lang.Boolean value)
          Sets the value of the IncludeSubclassesRequested property.
 void set_ObjectStateRecordingLevel(ObjectStateRecordingLevel value)
          Sets the value of the ObjectStateRecordingLevel property.
 
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_Id

Id get_Id()
Returns the value of the Id property. For more information, see Id Property.


get_EventClass

EventClassDefinition get_EventClass()
Returns the value of the EventClass property. For more information, see EventClass Property.


set_EventClass

void set_EventClass(EventClassDefinition value)
Sets the value of the EventClass property. For more information, see EventClass Property.


get_AuditSuccess

java.lang.Boolean get_AuditSuccess()
Returns the value of the AuditSuccess property. For more information, see AuditSuccess Property.


set_AuditSuccess

void set_AuditSuccess(java.lang.Boolean value)
Sets the value of the AuditSuccess property. For more information, see AuditSuccess Property.


get_AuditFailure

java.lang.Boolean get_AuditFailure()
Returns the value of the AuditFailure property. For more information, see AuditFailure Property.


set_AuditFailure

void set_AuditFailure(java.lang.Boolean value)
Sets the value of the AuditFailure property. For more information, see AuditFailure Property.


get_IncludeSubclassesRequested

java.lang.Boolean get_IncludeSubclassesRequested()
Returns the value of the IncludeSubclassesRequested property. For more information, see IncludeSubclassesRequested Property.


set_IncludeSubclassesRequested

void set_IncludeSubclassesRequested(java.lang.Boolean value)
Sets the value of the IncludeSubclassesRequested property. For more information, see IncludeSubclassesRequested Property.


get_ObjectStateRecordingLevel

ObjectStateRecordingLevel get_ObjectStateRecordingLevel()
Returns the value of the ObjectStateRecordingLevel property. For more information, see ObjectStateRecordingLevel Property.


set_ObjectStateRecordingLevel

void set_ObjectStateRecordingLevel(ObjectStateRecordingLevel value)
Sets the value of the ObjectStateRecordingLevel property. For more information, see ObjectStateRecordingLevel Property.



© Copyright IBM Corporation 2006, 2009. All rights reserved.