com.starteam.events

Interface ItemIDListener

All Superinterfaces:

java.util.EventListener, IItemListener

public interface ItemIDListener
extends IItemListener

Event-listener interface for ItemID events.

The ItemIDListener interface is a compromise between ItemListListener and ItemListener. It provides more information about each event than ItemListListener, but not as much information as ItemListener. It is more expensive to use than ItemListListener, but less expensive than ItemListener (particularly with respect to memory usage). For this reason, ItemIDListener may be the listener of choice for applications that must register listeners for multiple item types across many views.

Note that an application will not receive ItemID events for items that the logged-in user does not have permission to access.

See Also:

ItemListListener, ItemListener, View.addItemListener(com.starteam.events.IItemListener, com.starteam.Item.Type), Folder.addItemListener(com.starteam.events.IItemListener, com.starteam.Item.Type, int), ViewMemberListManager.addItemListener(com.starteam.events.IItemListener)

Method Summary

Modifier and Type	Method and Description
void	itemAdded(ItemIDEvent e) Invoked when an Item is added to a view.
void	itemChanged(ItemIDEvent e) Invoked when the properties of an Item have changed.
void	itemRemoved(ItemIDEvent e) Invoked when an Item is removed from a view.

Method Detail

itemAdded

void itemAdded(ItemIDEvent e)

Invoked when an Item is added to a view.

An itemAdded event is triggered whenever an Item with a new ItemID appears in the view. This might be because a new item was created; because an item was moved or shared in from another view; etc.

ItemIDEvent.getItemID() provides the ItemID of the item that was added.

If an item is moved from one folder to another folder within the same view, itemAdded and itemRemoved events are both triggered. The order in which they are triggered is unpredictable.

If the logged-in user does not have access rights to see the item in its new context, then no event is triggered.

Parameters:

e - The corresponding ItemID event.

See Also:

ItemIDEvent

itemChanged

void itemChanged(ItemIDEvent e)

Invoked when the properties of an Item have changed.

The changed properties may include Item-level properties (such as ConfigurationTime or BranchOnChange) or Object-level properties that are shared across references (such as CreatedUserID or ModifiedTime).

ItemIDEvent.getItemID() provides the ItemID of the item whose properties have changed.

Parameters:

e - The corresponding ItemID event.

See Also:

ItemIDEvent

itemRemoved

void itemRemoved(ItemIDEvent e)

Invoked when an Item is removed from a view.

An itemRemoved event is triggered whenever an Item disappears from the view. This might be because an item was deleted; because an item was moved to another view; etc.

ItemIDEvent.getItemID() provides the ItemID of the item that was removed.

If an item is moved from one folder to another folder within the same view, itemAdded and itemRemoved events are both triggered. The order in which they are triggered is unpredictable.

Parameters:

e - The corresponding ItemID event.

See Also:

ItemIDEvent