com.jivesoftware.forum
Interface Avatar

All Known Implementing Classes:

AvatarProxy, DbAvatar

public interface Avatar

An object that represents a user's avatar. Avatars give a user the ability to specify an image that will be displayed alongside their username throughout the application.

Method Summary

void	deleteProperty(java.lang.String name) Deletes an extended property.
Attachment	getAttachment() Returns the attachment for this avatar
long	getID() Returns the unique ID of the avatar
int	getModValue() Returns the moderation value for this Avatar
User	getOwner() Returns user who created this avatar, if the user is null then this is a global avatar
java.lang.String	getProperty(java.lang.String name) Returns an extended property of the attachment.
java.util.Iterator	getPropertyNames() Returns an Iterator for the names of the extended properties.
void	setModValue(int modValue) Modifies the moderation value of this specific avatar
void	setProperty(java.lang.String name, java.lang.String value) Sets an extended property of the attachment.

Method Detail

getID

long getID()

Returns the unique ID of the avatar

Returns:

the unique ID of the avatar

getModValue

int getModValue()

Returns the moderation value for this Avatar

Returns:

the moderation value for this Avatar

getAttachment

Attachment getAttachment()
                         throws AttachmentNotFoundException

Returns the attachment for this avatar

Returns:

the attachment for this avatar

Throws:

AttachmentNotFoundException - if we could not find an attachment for this avatar

getProperty

java.lang.String getProperty(java.lang.String name)

Returns an extended property of the attachment. Each attachment can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface.

Parameters:

name - the name of the property to get.

Returns:

the value of the property specified by name.

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)
                 throws UnauthorizedException

Sets an extended property of the attachment. Each attachment can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface.

If the property referenced by name already exists, its value will be updated.

Parameters:

name - the name of the property to set.

value - the new value for the property.

Throws:

UnauthorizedException - if does not have admin permissions.

deleteProperty

void deleteProperty(java.lang.String name)
                    throws UnauthorizedException

Deletes an extended property. If the property specified by name does not exist, this method will do nothing.

Parameters:

name - the name of the property to delete.

Throws:

UnauthorizedException - if does not have ADMIN permissions.

getPropertyNames

java.util.Iterator getPropertyNames()

Returns an Iterator for the names of the extended properties.

Returns:

an Iterator for the names of the extended properties.

getOwner

User getOwner()

Returns user who created this avatar, if the user is null then this is a global avatar

Returns:

user who created the avatar

setModValue

void setModValue(int modValue)
                 throws UnauthorizedException

Modifies the moderation value of this specific avatar

Parameters:

modValue - change the moderation value

Throws:

UnauthorizedException - thrown if the user does not have moderation privileges