com.adobe.cq.social.ugcbase

Interface CollabUser

public interface CollabUser

CollabUser represents a user in Social Collaboration applications.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANONYMOUS The name for an anonymous user.
static java.lang.String	PROP_EMAIL The property name for the email address.
static java.lang.String	PROP_NAME The property name for the user name.
static java.lang.String	PROP_WEBSITE The property name for the website URL.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEmail() Returns the email address of the user.
java.lang.String	getGravatar(java.lang.String defaultImage) Returns the URL to the user's gravatar image.
java.lang.String	getId() Returns the identifier of the user.
java.lang.String	getName() Returns the name of the user.
java.lang.String	getWebsite(java.lang.String defaultUrl) Returns the URL of the user's website.
boolean	isModified() Returns whether this user has been modified and needs to be saved.
void	save() Saves all changes made to this user.
void	setEmail(java.lang.String email) Sets the email address of the user.
void	setName(java.lang.String name) Sets the name of the user.
void	setWebsite(java.lang.String website) Sets the URL of the user's website.

Field Detail

ANONYMOUS

static final java.lang.String ANONYMOUS

The name for an anonymous user.

See Also:

Constant Field Values

PROP_NAME

static final java.lang.String PROP_NAME

The property name for the user name.

See Also:

Constant Field Values

PROP_WEBSITE

static final java.lang.String PROP_WEBSITE

The property name for the website URL.

See Also:

Constant Field Values

PROP_EMAIL

static final java.lang.String PROP_EMAIL

The property name for the email address.

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns the identifier of the user.

Returns:

the ID

getName

java.lang.String getName()

Returns the name of the user. If undefined, The ID will be used.

Returns:

the name

setName

void setName(java.lang.String name)

Sets the name of the user.

Parameters:

name - The user name

getEmail

java.lang.String getEmail()

Returns the email address of the user.

Returns:

the email address

setEmail

void setEmail(java.lang.String email)

Sets the email address of the user.

Parameters:

email - The email address

getWebsite

java.lang.String getWebsite(java.lang.String defaultUrl)

Returns the URL of the user's website.

Parameters:

defaultUrl - The default URL to use if undefined

Returns:

the website

setWebsite

void setWebsite(java.lang.String website)

Sets the URL of the user's website.

Parameters:

website - The website

getGravatar

java.lang.String getGravatar(java.lang.String defaultImage)

Returns the URL to the user's gravatar image. See http://en.gravatar.com for more information about gravatars.

Parameters:

defaultImage - The default image to display if no gravatar is available

Returns:

The Gravatar

isModified

boolean isModified()

Returns whether this user has been modified and needs to be saved.

Returns:

true if user is modified, false otherwise

See Also:

save()

save

void save()
   throws SocialException

Saves all changes made to this user. In case the user doesn't exist yet, it will be created.

Throws:

SocialException - if saving fails