com.ibm.ftt.resources.core.events
Interface IResourceSubscriptionEvent


public interface IResourceSubscriptionEvent

An interface for the resource subscription events.

See Also:
IResourceSubscription.notifySubscriber(com.ibm.ftt.resources.core.events.IResourceSubscriptionEvent)

Field Summary
static int ADD_MEMBER
          Value of the event type indicating a new member has been added to the resource.
static String COPY_RIGHT
           
static int DELETE
          Value of the event type indicating the resource has been deleted.
static int MIGRATE
          Value of the event type indicating the resource has been migrated.
static int POST_CACHE_CHANGE
          Value of the event type indicating the cache has been changed.
static int POST_CONTENT_CHANGE
          Value of the event type indicating the resource content has been changed.
static int PRE_DELETE
          Value of the event type indicating a before-the-fact report of the impending deletion of the resource.
static int RECALL
          Value of the event type indicating the resource has been recalled.
static int REFRESH
          Value of the event type indicating the resource has changed and UI object should be refreshed.
static int REMOVE
          Value of the event type indicating the resource has been removed.
static int REMOVE_MEMBER
          Value of the event type indicating a member has been removed from the resource.
static int RENAME
          Value of the event type indicating the resource has been renamed.
 
Method Summary
 int getEventType()
          Returns the type of resource subscription event.
 Object getNewValue()
          Returns the new value associated with this event.
 Object getOldValue()
          Returns the old value associated with this event.
 Object getPublisher()
          Returns the object that is the source of this event.
 

Field Detail

COPY_RIGHT

static final String COPY_RIGHT
See Also:
Constant Field Values

DELETE

static final int DELETE
Value of the event type indicating the resource has been deleted.

See Also:
Constant Field Values

RENAME

static final int RENAME
Value of the event type indicating the resource has been renamed. The previous name and new name can be obtained using IResourceSubscriptionEvent.getOldValue() and IResourceSubscriptionEvent.getNewValue().

See Also:
Constant Field Values

PRE_DELETE

static final int PRE_DELETE
Value of the event type indicating a before-the-fact report of the impending deletion of the resource.

Since:
7.6.1
See Also:
Constant Field Values

ADD_MEMBER

static final int ADD_MEMBER
Value of the event type indicating a new member has been added to the resource. The new member can be obtained using IResourceSubscriptionEvent.getNewValue().

See Also:
Constant Field Values

REMOVE_MEMBER

static final int REMOVE_MEMBER
Value of the event type indicating a member has been removed from the resource. The removed member can be obtained using IResourceSubscriptionEvent.getOldValue().

This event is typically used for logical resources.

Note: this constant may be refactored to a different class in future.

See Also:
Constant Field Values

REMOVE

static final int REMOVE
Value of the event type indicating the resource has been removed.

This event is typically used for logical resources.

NOTE: this constant may be refactored to a different class in future.

See Also:
Constant Field Values

MIGRATE

static final int MIGRATE
Value of the event type indicating the resource has been migrated.

See Also:
Constant Field Values

RECALL

static final int RECALL
Value of the event type indicating the resource has been recalled.

See Also:
Constant Field Values

REFRESH

static final int REFRESH
Value of the event type indicating the resource has changed and UI object should be refreshed. This event type is used in case the change is not applicable to the other event types but it could affect UI.

See Also:
Constant Field Values

POST_CONTENT_CHANGE

static final int POST_CONTENT_CHANGE
Value of the event type indicating the resource content has been changed. This event is published immediately after the content change.

See Also:
Constant Field Values

POST_CACHE_CHANGE

static final int POST_CACHE_CHANGE
Value of the event type indicating the cache has been changed. This event is published immediately after the cache change.

See Also:
Constant Field Values
Method Detail

getEventType

int getEventType()
Returns the type of resource subscription event.

Returns:
one of the event type constants defined in this interface or specializations of this interface.

getPublisher

Object getPublisher()
Returns the object that is the source of this event.

Returns:
the object that is the source of this resource subscription event.

getOldValue

Object getOldValue()
Returns the old value associated with this event.

Returns:
the old value or null if it is not applicable to this event. For example, old name for IResourceSubscriptionEvent.RENAME event. null for ADD_MEMBER event.
See Also:
IResourceSubscriptionEvent.RENAME, IResourceSubscriptionEvent.REMOVE_MEMBER

getNewValue

Object getNewValue()
Returns the new value associated with this event.

Returns:
the new value or null if it is not applicable to this event. For example, new name for IResourceSubscriptionEvent.RENAME event. null for DELETE event.
See Also:
IResourceSubscriptionEvent.RENAME, IResourceSubscriptionEvent.ADD_MEMBER