com.starbase.starteam
Class User

java.lang.Object
  |
  +--com.starbase.starteam.CacheRef
        |
        +--com.starbase.starteam.User

All Implemented Interfaces:

java.lang.Cloneable

public class User

extends CacheRef

Represents a StarTeam user. Only a limited subset of the whole user information is available. The UserAccount class has the full user information but it is only accessible to user's with the appropriate permissions.

See Also:

UserAccount, Permission.SERVER_ADMIN_USER_ACCOUNTS

Method Summary

User	copy() Creates a copy of this User object.
boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
int	getID() Returns the integer idenitifier for this user.
java.lang.String	getName() Returns the user's name.
Server	getServer() Returns the Server object to which this user belongs.
int	hashCode() returns a unique hash for all instances of this type
boolean	isDeleted() Returns true if this user has been deleted.
boolean	isEqualTo(User user) Compares two User objects.
java.lang.String	toString() Returns the user's name.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

copy

public User copy()

Creates a copy of this User object. Useful to applications that want to save a snapshot of the user in a given state, for example, before calling Server.refreshUsers().

Returns:

A new copy of this User object.

See Also:

User.isEqualTo(com.starbase.starteam.User)

isEqualTo

public boolean isEqualTo(User user)

Compares two User objects.

Parameters:

user - The User to be compared with this one.

Returns:

true if no differences were found.

See Also:

User.copy()

getServer

public Server getServer()

Returns the Server object to which this user belongs.

Returns:

the Server object to which this user belongs.

getID

public int getID()

Returns the integer idenitifier for this user.

Returns:

the integer idenitifier for this user.

getName

public java.lang.String getName()

Returns the user's name. This is not the same as the user's logon name.

Returns:

the user's name

See Also:

UserAccount.getName(), UserAccount.getLogOnName()

isDeleted

public boolean isDeleted()

Returns true if this user has been deleted.

Returns:

true if this user has been deleted.

toString

public java.lang.String toString()

Returns the user's name.

Overrides:

toString in class java.lang.Object

Returns:

the user's name.

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class java.lang.Object

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class java.lang.Object

Returns:

int a unique hash for all instances of this type