|
Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.webservices.User
public class User
Provides information about and services for users of the system. Users can be identified by a unique id or username. Users can also be organized into groups for easier management of permissions.
Constructor Summary | |
---|---|
User()
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
java.util.Date |
getCreationDate()
Returns the date that the user was created. |
java.lang.String |
getEmail()
Returns the user's email address. |
long |
getID()
Returns the user's id. |
java.util.Date |
getModificationDate()
Returns the date that the user was last modified. |
java.lang.String |
getName()
Returns the user's name. |
java.lang.String |
getPassword()
|
java.lang.String |
getPasswordHash()
Returns the user's password in hashed form. |
java.lang.String |
getUsername()
Returns the user's username. |
int |
hashCode()
|
boolean |
isEmailVisible()
Returns true if the user has chosen to make her email visible to other users. |
boolean |
isNameVisible()
Returns true if the user has chosen to make her name visible to other users. |
void |
setCreationDate(java.util.Date creationDate)
Sets the creation date of the user. |
void |
setEmail(java.lang.String email)
Sets the user's email address. |
void |
setEmailVisible(boolean visible)
Sets whether a user's email is visible to other users. |
void |
setID(long id)
|
void |
setModificationDate(java.util.Date modificationDate)
Sets the date the user was last modified. |
void |
setName(java.lang.String name)
Sets the user's name. |
void |
setNameVisible(boolean visible)
Sets whether a user's name is visible to other users. |
void |
setPassword(java.lang.String password)
Sets the users's password. |
void |
setPasswordHash(java.lang.String passwordHash)
Sets the user's password in hashed form. |
void |
setUsername(java.lang.String username)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public User()
Method Detail |
---|
public long getID()
public void setID(long id)
public java.lang.String getUsername()
public void setUsername(java.lang.String username)
public java.lang.String getName()
public void setName(java.lang.String name)
name
- new name for the user.
UnauthorizedException
- if does not have administrator permissions.public boolean isNameVisible()
public void setNameVisible(boolean visible)
visible
- boolean value to determin if the name should be visible.
UnauthorizedException
- if does not have administrator permissions.public void setPassword(java.lang.String password)
password
- new password for the user.
UnauthorizedException
- if does not have administrator permissions.public java.lang.String getPassword()
public java.lang.String getPasswordHash()
If your back-end user store does not support this operation, throw an UnsupportedOperationException.
UnauthorizedException
- if does not have administrator permissions.public void setPasswordHash(java.lang.String passwordHash)
If your back-end user store does not support this operation, throw an UnsupportedOperationException.
passwordHash
- the hashedPassword for the user.
UnauthorizedException
- if does not have administrator permissions.public java.lang.String getEmail()
If your back-end user store does not support this operation, always return null.
public void setEmail(java.lang.String email)
If your back-end user store does not support this operation, throw an UnsupportedOperationException.
email
- new email address for the user.
UnauthorizedException
- if does not have administrator permissions.public boolean isEmailVisible()
public void setEmailVisible(boolean visible)
visible
- boolean value to determin if the name should be visible.
UnauthorizedException
- if does not have administrator permissions.public java.util.Date getCreationDate()
If your back-end user store does not support this operation, throw an UnsupportedOperationException.
public void setCreationDate(java.util.Date creationDate)
creationDate
- the date the user was created.
UnauthorizedException
- if does not have administrator permissions.public java.util.Date getModificationDate()
public void setModificationDate(java.util.Date modificationDate)
modificationDate
- the date the user was modified.
UnauthorizedException
- if does not have administrator permissions.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |