|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Not Implemented in CS Java Connector v3.0.
AnEvent
object represents an instance of a recorded audit event
for a specific object. The primary use of an Event
object is
to retrieve audit logging information.
An Event
object is created by the Content Services server whenever
a subscribed-to audit event fires. An Event
object is also created
whenever you successfully call the raiseEvent
method on a CustomObject
,
Document
, or Folder
object.
Note that you can retrieve the source object for an audit event by retrieving
an Event
object's SourceObject property. (The source object is the
object that generated the event.) However, method calls on the returned source
object will operate on the source object as it currently exists and not on the
recorded source object (that is, the source object as it existed at the time
the audit event was recorded). To retrieve permissions for a recorded source
object, call the
getSourceObjectPermissions
method; to retrieve properties, call one of the forms of the
getSourceObjectProperties
method.
Field Summary |
Method Summary | |
Permissions |
getSourceObjectPermissions()
Not Implemented in CS Java Connector v3.0. |
Properties |
getSourceObjectProperties()
Not Implemented in CS Java Connector v3.0. |
Properties |
getSourceObjectProperties(java.lang.String[] propNames)
Not Implemented in CS Java Connector v3.0. |
java.lang.String |
getSourceObjectPropertiesXML(java.lang.String[] propNames)
Not Implemented in CS Java Connector v3.0. |
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject |
getPermissions, getPermissions |
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject |
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh |
Methods inherited from interface com.filenet.wcm.api.BaseObject |
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject |
Method Detail |
public Properties getSourceObjectProperties() throws PropertyNotFoundException
Not Implemented in CS Java Connector v3.0.
Returns all readily-available properties for the recorded source object that is associated with thisEvent
object.
This method throws an exception if you call it on an Event
object whose class does not have a SourceObject property
Note that any object referenced as the value of a returned object-valued
property will be the object as it existed at the time the audit event
was recorded. However, any property retrievals from the referenced
object will return properties from the object as it currently exists.
To retrieve a specific set of properties for a recorded source object, use the
getSourceObjectProperties(propNames)
form of this method.
Properties
collection that contains all
readily-available properties for
the source object that is associated with this Event
object.
PropertyNotFoundException
- Thrown when this
method is unable to retrieve properties for the source object
from the Content Services server.
public Properties getSourceObjectProperties(java.lang.String[] propNames) throws PropertyNotFoundException
Not Implemented in CS Java Connector v3.0.
Returns the requested properties for the recorded source object that is associated with thisEvent
object.
This method throws an exception if you call it on an Event
object whose class does not have a SourceObject property
If the
propNames
parameter is null
or an empty array,
this method returns all readily-available
properties for the source object.
The Property
elements in the collection are
returned in the same order as their corresponding elements in the specified
propNames
array.
Note that any object referenced as the value of a returned object-valued
property will be the object as it existed at the time the audit event
was recorded. However, any property retrievals from the referenced
object will return properties from the object as it currently exists.
propNames
- A String array whose elements specify the
symbolic names of the properties to retrieve.
If null
or an empty array, retrieves
all readily-available properties.
Properties
collection that contains the requested properties
for the source object that is associated with this Event
object.
PropertyNotFoundException
- Thrown when this
method is unable to retrieve the specified properties for the
source object from the Content Services server.
public java.lang.String getSourceObjectPropertiesXML(java.lang.String[] propNames)
Not Implemented in CS Java Connector v3.0.
Returns a string in XML that represents the requested properties for the recorded source object that is associated with thisEvent
object.
This method throws an exception if you call it on an Event
object whose class does not have a SourceObject property
If the propNames
parameter is null
or an empty array, this method returns all
readily-available properties for the source object.
(For information on which properties are not returned.
If the array includes
properties that do not exist for the source object,
those properties are ignored (no exception is thrown). Note that this
method never returns binary-valued properties.
propNames
- A String array whose elements specify the
symbolic names of the properties to retrieve.
If null
or an empty array, retrieves all
readily-available properties (except for binary-valued ones).
Event
object.
public Permissions getSourceObjectPermissions()
Not Implemented in CS Java Connector v3.0.
Retrieves permissions for the recorded source object that is associated with thisEvent
object.
The user must have Read permission on the source object's security (either
Permission.LEVEL_VIEW
or Permission.RIGHT_READ_ACL
)
to retrieve the object's permissions.
This method throws an exception if you call it on an Event
object whose class does not have a SourceObject property or where the
source object does not have a Permissions property
This method filters out Access Control Elements (ACEs) that correspond
to deleted grantees (users or groups). For example, if a source object's
permissions list contains a user account that has been deleted from the
directory server database, the object's Permissions
collection
returned by this method will not include Permission
objects
corresponding to that deleted account.
Note that the returned Permissions
collection represents
basic object permissions (that is, the source object's Permissions property).
Permissions
collection containing the basic object
permissions for the source object that is associated with this
Event
object. Elements that correspond to deleted grantees
(users or groups) are not included.
|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |