com.starteam.events
Class UserEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.starteam.events.UserEvent
All Implemented Interfaces:
java.io.Serializable

public final class UserEvent
extends java.util.EventObject

An event triggered whenever a User is added, changed or deleted on the server. User events are also triggered when user group membership list is modified, from 12.0 release of server onwards.

See Also:
UserListener, Server.addUserListener(com.starteam.events.UserListener), Serialized Form

Method Summary
 User getUser()
          Gets the User that has been added, changed or deleted, in its new state.
 java.lang.String toString()
          Gets a short description of this UserEvent.
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getUser

public User getUser()
Gets the User that has been added, changed or deleted, in its new state.

Returns a User object that is not a member of the Server's User collection (that is, it is not among the User objects returned by Server.getUsers()). There may be a User in the collection with the same ID, but it would be a physically different object that is likely to have different properties.

If an application wants to refresh the User objects in the Server's User collection, it must explicitly call Server.refreshUsers().

Returns:
The User that has been added, changed or deleted, in its new state.
See Also:
User, Server.getUsers(), Server.refreshUsers()

toString

public java.lang.String toString()
Gets a short description of this UserEvent.

Overrides:
toString in class java.util.EventObject
Returns:
A short description of this UserEvent.


StarTeam SDK 14.0, Build 21
Copyright © 2003-2012 Borland Software Corporation. All rights reserved.