com.starbase.starteam
Class MyUserAccount

java.lang.Object
  |
  +--com.starbase.starteam.MyUserAccount

public class MyUserAccount

extends java.lang.Object

This class represents the user account information that every user can specify/modify about themselves. The basic proceedure is to call the Server.getMyUserAccount, then modify the appropriate fields then call update() on the object to save the changes on the server.

See Also:

Server.getMyUserAccount()

Method Summary

MyUserAccount	copy() Creates a copy of this user account.
boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
java.lang.String	getEmailAddress() Returns the user's email address.
java.lang.String	getFaxNumber() Returns the user's fax number.
int	getID() Returns the integer that represents this user account.
java.lang.String	getLogOnName() Returns ths user's logon name.
int	getMinimumPasswordLength() Returns the minimum required password length.
java.lang.String	getName() Returns the full name that this user goes by.
java.lang.String	getPagerNumber() Returns the user's pager number.
boolean	getPasswordChangeRequired() Determines whether or not a password change is required during the current session.
int	getPasswordDaysRemaining() Returns the number of days remaining that the user's current password will remain valid.
java.lang.String	getPhoneNumber() Returns the user's phone number.
java.lang.String	getPostalAddress() Returns the user's postal address.
java.lang.String	getVoiceMailNumber() Return the user's voice mail number.
int	hashCode() returns a unique hash for all instances of this type
boolean	isEqualTo(MyUserAccount account) Compares two user account objects.
void	setEmailAddress(java.lang.String emailAddress) Changes the user's email address.
void	setFaxNumber(java.lang.String faxNumber) Changes the user's fax number.
void	setName(java.lang.String name) Changes the user's full name.
void	setPagerNumber(java.lang.String pagerNumber) Changes the user's pager number.
void	setPassword(java.lang.String password) Modify the user's password.
void	setPhoneNumber(java.lang.String phoneNumber) Changes the user's phone number.
void	setPostalAddress(java.lang.String postalAddress) Changes the user's postal address.
void	setVoiceMailNumber(java.lang.String voiceMailNumber) Changes the user's voice mail number.
java.lang.String	toString() Returns a string summary of all the properties of this object.
void	update() Updates this user account information on the StarTeam server.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getID

public int getID()

Returns the integer that represents this user account.

Returns:

the integer that represents this user account.

getName

public java.lang.String getName()

Returns the full name that this user goes by.

Returns:

the full name that this user goes by.

setName

public void setName(java.lang.String name)

Changes the user's full name.

Parameters:

name - the new name for this user

getEmailAddress

public java.lang.String getEmailAddress()

Returns the user's email address.

Returns:

the user's email address.

setEmailAddress

public void setEmailAddress(java.lang.String emailAddress)

Changes the user's email address.

Parameters:

emailAddress - the new email address for this user

getPostalAddress

public java.lang.String getPostalAddress()

Returns the user's postal address.

Returns:

the user's postal address.

setPostalAddress

public void setPostalAddress(java.lang.String postalAddress)

Changes the user's postal address.

Parameters:

postalAddress - the user's new postal address

getFaxNumber

public java.lang.String getFaxNumber()

Returns the user's fax number.

Returns:

the user's fax number.

setFaxNumber

public void setFaxNumber(java.lang.String faxNumber)

Changes the user's fax number.

Parameters:

faxNumber - the user's new fax number.

getPagerNumber

public java.lang.String getPagerNumber()

Returns the user's pager number.

Returns:

the user's pager number.

setPagerNumber

public void setPagerNumber(java.lang.String pagerNumber)

Changes the user's pager number.

Parameters:

pagerNumber - the user's new pager number.

getPhoneNumber

public java.lang.String getPhoneNumber()

Returns the user's phone number.

Returns:

the user's phone number.

setPhoneNumber

public void setPhoneNumber(java.lang.String phoneNumber)

Changes the user's phone number.

Parameters:

phoneNumber - the user's new phone number.

getVoiceMailNumber

public java.lang.String getVoiceMailNumber()

Return the user's voice mail number.

Returns:

the user's voice mail number.

setVoiceMailNumber

public void setVoiceMailNumber(java.lang.String voiceMailNumber)

Changes the user's voice mail number.

Parameters:

voiceMailNumber - the user's new voice mail number.

getLogOnName

public java.lang.String getLogOnName()

Returns ths user's logon name.

Returns:

ths user's logon name.

setPassword

public void setPassword(java.lang.String password)

Modify the user's password. The maximum password length is 127 characters.

Parameters:

password - the new password.

getMinimumPasswordLength

public int getMinimumPasswordLength()

Returns the minimum required password length.

Returns:

the minimum required password length.

getPasswordChangeRequired

public boolean getPasswordChangeRequired()

Determines whether or not a password change is required during the current session. If the password is not changed, the user will lose access to the StarTeam server.

Returns:

true if a password change is required during the current session.

getPasswordDaysRemaining

public int getPasswordDaysRemaining()

Returns the number of days remaining that the user's current password will remain valid.

Returns:

The number of days remaining that the user's current password will remain valid, or -1 if the password will not expire.

update

public void update()

Updates this user account information on the StarTeam server.

copy

public MyUserAccount copy()

Creates a copy of this user account.

Returns:

A new copy of this user account.

See Also:

MyUserAccount.isEqualTo(com.starbase.starteam.MyUserAccount)

isEqualTo

public boolean isEqualTo(MyUserAccount account)

Compares two user account objects.

Parameters:

account - The user account to be compared with this one.

Returns:

true if no differences were found.

See Also:

MyUserAccount.copy()

toString

public java.lang.String toString()

Returns a string summary of all the properties of this object.

Overrides:

toString in class java.lang.Object

Returns:

a string summary of all the properties of this object.

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