Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.proxy
Class AvatarProxy

java.lang.Object
  extended by com.jivesoftware.forum.proxy.AvatarProxy
All Implemented Interfaces:
Avatar

public class AvatarProxy
extends java.lang.Object
implements Avatar


Constructor Summary
AvatarProxy(Avatar avatar, AuthToken authToken, Permissions permissions)
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AvatarProxy

public AvatarProxy(Avatar avatar,
                   AuthToken authToken,
                   Permissions permissions)
Method Detail

getID

public long getID()
Description copied from interface: Avatar
Returns the unique ID of the avatar

Specified by:
getID in interface Avatar
Returns:
the unique ID of the avatar

getModValue

public int getModValue()
Description copied from interface: Avatar
Returns the moderation value for this Avatar

Specified by:
getModValue in interface Avatar
Returns:
the moderation value for this Avatar

getAttachment

public Attachment getAttachment()
                         throws AttachmentNotFoundException
Description copied from interface: Avatar
Returns the attachment for this avatar

Specified by:
getAttachment in interface Avatar
Returns:
the attachment for this avatar
Throws:
AttachmentNotFoundException - if we could not find an attachment for this avatar

getProperty

public java.lang.String getProperty(java.lang.String name)
Description copied from interface: Avatar
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.

Specified by:
getProperty in interface Avatar
Parameters:
name - the name of the property to get.
Returns:
the value of the property specified by name.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
                 throws UnauthorizedException
Description copied from interface: Avatar
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.

Specified by:
setProperty in interface Avatar
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

public void deleteProperty(java.lang.String name)
                    throws UnauthorizedException
Description copied from interface: Avatar
Deletes an extended property. If the property specified by name does not exist, this method will do nothing.

Specified by:
deleteProperty in interface Avatar
Parameters:
name - the name of the property to delete.
Throws:
UnauthorizedException - if does not have ADMIN permissions.

getPropertyNames

public java.util.Iterator getPropertyNames()
Description copied from interface: Avatar
Returns an Iterator for the names of the extended properties.

Specified by:
getPropertyNames in interface Avatar
Returns:
an Iterator for the names of the extended properties.

getOwner

public User getOwner()
Description copied from interface: Avatar
Returns user who created this avatar, if the user is null then this is a global avatar

Specified by:
getOwner in interface Avatar
Returns:
user who created the avatar

setModValue

public void setModValue(int modValue)
                 throws UnauthorizedException
Description copied from interface: Avatar
Modifies the moderation value of this specific avatar

Specified by:
setModValue in interface Avatar
Parameters:
modValue - change the moderation value
Throws:
UnauthorizedException - thrown if the user does not have moderation privileges

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.