Eclipse RSE Development Guide (Galileo) - ISystemResourceChangeEvent (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core.events
Interface ISystemResourceChangeEvent

All Known Implementing Classes:: SystemResourceChangeEvent, SystemResourceChangeEventUI

public interface ISystemResourceChangeEvent

Interface of event sent when a remote system resource changes. These events are mainly for internal use. BPs/ISVs should instead fire and monitor for ISystemModelChangeEvent.

See Also:: ISystemResourceChangeEvents

Method Summary

Object getGrandParent ()
          Returns the grandparent of the object source.

Object[] getMultiSource ()
          For multi-target events, return the array of source targets.

Object getParent ()
          Returns the parent of the object source.

int getPosition ()
          Return the position value for adding a new item.

Object getRelativePrevious ()
          For relative add events, return the previous node this is being added after.

Object getSource ()
          Returns an object identifying the source of this event.

int getType ()
          Returns the type of the event.

void setParent ( Object parent)
          Set the parent object of this event.

void setPosition (int position)
          Set the position value for adding a new item.

void setRelativePrevious ( Object previousObject)
          For relative add events, set the previous node this is being added after.

void setType (int type)
          Set the type of this event

Method Detail

getSource


Object getSource()

Returns an object identifying the source of this event.

Returns:: an object identifying the source of this event
See Also:: EventObject

getMultiSource


Object[] getMultiSource()

For multi-target events, return the array of source targets.

Returns:: array of source objects.

getParent


Object getParent()

Returns the parent of the object source. Only guaranteed to be set for additions and deletions.

Returns:: an object identifying the parent of the source of this event, or null if not applicable.

setParent

void setParent(
Object parent)

Set the parent object of this event.

Parameters:: parent - the parent object.

getGrandParent


Object getGrandParent()

Returns the grandparent of the object source. Only guaranteed to be set for special case events, which have a special contract with the SystemView.

Returns:: an object identifying the grandparent of the source of this event

getPosition

int getPosition()

Return the position value for adding a new item. Used in ADD events. A negative number indicates an append operation.

Returns:: position to add the new item to.

setPosition

void setPosition(int position)

Set the position value for adding a new item. Used in ADD events. A negative number indicates an append operation.

Parameters:: position - zero-based position to insert the new item.

getRelativePrevious


Object getRelativePrevious()

For relative add events, return the previous node this is being added after.

Returns:: the previous node for adding a new node after.

setRelativePrevious

void setRelativePrevious(
Object previousObject)

For relative add events, set the previous node this is being added after.

Parameters:: previousObject - the object after which to add the new object.

getType

int getType()

Returns the type of the event.

Returns:: a type that is one of the constants in ISystemResourceChangeEvents.
See Also:: ISystemResourceChangeEvents

setType

void setType(int type)

Set the type of this event

Parameters:: type - a type that is one of the constants in ISystemResourceChangeEvents.
See Also:: ISystemResourceChangeEvents