CMSSessionBurstEvent Module
The CMSSessionBurstEvent module has the following event types:
CMSSessionBurstDocument
This event occurs before a document is burst into the repository.There is no equivalent ACL hook for this event.
The event handler's ability to assign new values to the topLevelName and folderLogicalId properties can replace object location and naming rule hooks, which are implemented as inline ACL code in a burst configuration file.
This event type is cancelable. If an event listener calls the preventDefault method, the burst will be canceled. In this case, the pending transaction (if supported) will be rolled back.
The following module properties provide the context information for this event:
canOverride
Represents whether the event handler is allowed to override the topLevelName and folderLogicalId properties. If canOverride is false, then any changes to these properties will have no effect. If canOverride is true, then the event handler can set new values for these properties if desired.
topLevelName
Represents the name of the top-level object which will result from bursting the document. This may be null or empty which means the name will be auto-generated according to the bursting rules for this adapter. The event handler can override this value if canOverride is true.
folderLogicalId
Represents the repository folder which will hold the top-level object which will result from bursting the document. This may be null or empty which means the folder will be chosen according to the bursting rules for this adapter. The event handler can override this value if canOverride is true.
document
Represents the document being burst.
flags
Same as the flags parameter to the CMSSession.burstDocument method.
◦ Bubbles: Yes
◦ Cancelable: Yes
◦ Context Info: canOverride, topLevelName, folderLogicalId, document, flags
CMSSessionPostBurstDocument
This event occurs after a document has been burst. As such, it is not cancelable. There is no equivalent ACL hook for this event.
The following module property provides the context information for this event:
document
Represents the document which has been burst.
◦ Bubbles: Yes
◦ Cancelable: No
◦ Context Info: document