com.jivesoftware.forum.proxy
Class StatusLevelProxy

java.lang.Object
  com.jivesoftware.forum.proxy.StatusLevelProxy

All Implemented Interfaces:

StatusLevel

public class StatusLevelProxy
extends java.lang.Object
implements StatusLevel

Constructor Summary

StatusLevelProxy(StatusLevel statusLevel, AuthToken authToken, Permissions permissions)

Method Summary

void	deleteProperty(java.lang.String name) Deletes an extended property.
java.lang.String	getDescription() Returns the description of this status level
Group	getGroup() The group this status level is associated with.
long	getID() Returns the unique id of this status level
java.lang.String	getImagePath() Returns the relative path to the image.
java.lang.String	getLargeImagePath()
int	getMaxPoints() Returns the maximum value for a status level point range. -1 means unbounded (unless there is a group specified)
int	getMinPoints() Returns the minimum value for a status level point range. -1 means unbounded (unless there is a group specified)
java.lang.String	getName() Returns the name of this status level
java.lang.String	getProperty(java.lang.String name) Returns an extended property of the status level.
java.util.Iterator	getPropertyNames() Returns an Iterator for the names of the status level properties.
boolean	isInRange(int pointValue) Used to check to see if a point value is in the range for this status level
void	setDescription(java.lang.String description) Sets the description of this status level
void	setGroup(Group group) The group this status level is associated with.
void	setImagePath(java.lang.String imagePath) Sets the path of the image used for this status level.
void	setLargeImagePath(java.lang.String largeImagePath)
void	setName(java.lang.String name) Sets the name of this status level
void	setPointRange(int minPoints, int maxPoints) Sets a point range for this status level, if this status level was group based before it will now be point based.
void	setProperty(java.lang.String name, java.lang.String value) Sets an extended property of the status level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatusLevelProxy

public StatusLevelProxy(StatusLevel statusLevel,
                        AuthToken authToken,
                        Permissions permissions)

Method Detail

getID

public long getID()

Description copied from interface: StatusLevel

Returns the unique id of this status level

Specified by:

getID in interface StatusLevel

Returns:

the unique id of this status level

setName

public void setName(java.lang.String name)
             throws UnauthorizedException,
                    StatusLevelException

Description copied from interface: StatusLevel

Sets the name of this status level

Specified by:

setName in interface StatusLevel

Parameters:

name - the name of this status level

Throws:

UnauthorizedException - if not system admin

StatusLevelException - if you try to set a null name

getName

public java.lang.String getName()

Description copied from interface: StatusLevel

Returns the name of this status level

Specified by:

getName in interface StatusLevel

Returns:

the name of this status level

setDescription

public void setDescription(java.lang.String description)
                    throws UnauthorizedException

Description copied from interface: StatusLevel

Sets the description of this status level

Specified by:

setDescription in interface StatusLevel

Parameters:

description - description of this status level

Throws:

UnauthorizedException - if not system admin

getDescription

public java.lang.String getDescription()

Description copied from interface: StatusLevel

Returns the description of this status level

Specified by:

getDescription in interface StatusLevel

Returns:

the description of this status level

setImagePath

public void setImagePath(java.lang.String imagePath)
                  throws UnauthorizedException,
                         StatusLevelException

Description copied from interface: StatusLevel

Sets the path of the image used for this status level. This should be a relative path.

Specified by:

setImagePath in interface StatusLevel

Parameters:

imagePath - the path of the image used for this status level

Throws:

UnauthorizedException - if not system admin

StatusLevelException - if you try to set a null image path

getImagePath

public java.lang.String getImagePath()

Description copied from interface: StatusLevel

Returns the relative path to the image.

Specified by:

getImagePath in interface StatusLevel

Returns:

the relative path to the image.

getLargeImagePath

public java.lang.String getLargeImagePath()

Specified by:

getLargeImagePath in interface StatusLevel

setLargeImagePath

public void setLargeImagePath(java.lang.String largeImagePath)
                       throws UnauthorizedException

Specified by:

setLargeImagePath in interface StatusLevel

Throws:

UnauthorizedException

getMinPoints

public int getMinPoints()

Description copied from interface: StatusLevel

Returns the minimum value for a status level point range. -1 means unbounded (unless there is a group specified)

Specified by:

getMinPoints in interface StatusLevel

Returns:

the minimum value for a status level point range.

getMaxPoints

public int getMaxPoints()

Description copied from interface: StatusLevel

Returns the maximum value for a status level point range. -1 means unbounded (unless there is a group specified)

Specified by:

getMaxPoints in interface StatusLevel

Returns:

the maximum value for a status level point range.

setGroup

public void setGroup(Group group)
              throws UnauthorizedException,
                     StatusLevelException

Description copied from interface: StatusLevel

The group this status level is associated with. If a group is set this means that this status level is group based.

Calling this method will set minPoints and maxPoints = -1 (disabling the point based system)

If you decide to set this status level to be point based, first set this method to null then set the min and max values.

Specified by:

setGroup in interface StatusLevel

Throws:

UnauthorizedException

StatusLevelException - if there are minPoints or maxPoints values greater than -1.

getGroup

public Group getGroup()

Description copied from interface: StatusLevel

The group this status level is associated with. This will return null if the status level is point based.

Specified by:

getGroup in interface StatusLevel

Returns:

group this status level is associated with, null if point based

getProperty

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

Description copied from interface: StatusLevel

Returns an extended property of the status level. Each status level 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 StatusLevel

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: StatusLevel

Sets an extended property of the status level. Each status level 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 StatusLevel

Parameters:

name - the name of the property to set.

value - the new value for the property.

Throws:

UnauthorizedException - if not system admin

deleteProperty

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

Description copied from interface: StatusLevel

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

Specified by:

deleteProperty in interface StatusLevel

Parameters:

name - the name of the property to delete.

Throws:

UnauthorizedException - if not system admin

getPropertyNames

public java.util.Iterator getPropertyNames()

Description copied from interface: StatusLevel

Returns an Iterator for the names of the status level properties.

Specified by:

getPropertyNames in interface StatusLevel

Returns:

an Iterator for the names of the status level properties.

isInRange

public boolean isInRange(int pointValue)

Description copied from interface: StatusLevel

Used to check to see if a point value is in the range for this status level

Specified by:

isInRange in interface StatusLevel

Parameters:

pointValue - point value to check

Returns:

true if pointValue is in the status level's range

setPointRange

public void setPointRange(int minPoints,
                          int maxPoints)
                   throws UnauthorizedException,
                          StatusLevelException

Description copied from interface: StatusLevel

Sets a point range for this status level, if this status level was group based before it will now be point based.

Setting maxPoints to a negative number means unbounded, minPoints must be 0 or greater.

minPoints value cannot be greater than the maxPoints value, though they can be the same.

Specified by:

setPointRange in interface StatusLevel

Parameters:

minPoints - minimum value for the point range

maxPoints - maximmum value for the point range

Throws:

UnauthorizedException - UnauthorizedException if not system admin

StatusLevelException - if an illegal point range is specified