com.webmethods.portal.event

Interface IPurgeRequestEvent

All Superinterfaces:

IEvent, ISystemEvent, Serializable

public interface IPurgeRequestEvent
extends ISystemEvent

Raised to request that a system purge be conducted. During a purge items that have been deleted are removed form the system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IPurgeRequestEvent.IListener
static interface	IPurgeRequestEvent.ISynchronousListener
static class	IPurgeRequestEvent.Listeners
static class	IPurgeRequestEvent.SynchronousListeners

Nested classes/interfaces inherited from interface com.webmethods.portal.event.ISystemEvent

ISystemEvent.QueueListeners

Method Summary

Modifier and Type	Method and Description
boolean	getPurgeAll() Returns whether all deleted items should be purge or not.
IThingIDList	getThingsToPurge() Returns a list of deleted items that are being requested to be purged.

Methods inherited from interface com.webmethods.portal.event.ISystemEvent

getUserID

Methods inherited from interface com.webmethods.rtl.event.IEvent

getJcrSessionID, getJcrSessionUserData, getSourceIP, getTimestamp, getVMID, isLocalEvent, raise

Method Detail

getPurgeAll

boolean getPurgeAll()

Returns whether all deleted items should be purge or not. If this value is false, getThingsToPurge() should be used to obtain the list of deleted items that are being requested to be purged.

Returns:

boolean flag indicating whether all deleted items should be purged or not.

getThingsToPurge

IThingIDList getThingsToPurge()

Returns a list of deleted items that are being requested to be purged.

Returns:

{alink IThingIDList} of items that are being requested to be purged.