|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StatusLevel
Represents a status Level in the system.
If there is a group specified for this instance, then it is a group based status level, else there should be valid minPoints and maxPoints values.
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. |
Method Detail |
---|
long getID()
void setName(java.lang.String name) throws UnauthorizedException, StatusLevelException
name
- the name of this status level
UnauthorizedException
- if not system admin
StatusLevelException
- if you try to set a null namejava.lang.String getName()
void setDescription(java.lang.String description) throws UnauthorizedException
description
- description of this status level
UnauthorizedException
- if not system adminjava.lang.String getDescription()
void setImagePath(java.lang.String imagePath) throws UnauthorizedException, StatusLevelException
imagePath
- the path of the image used for this status level
UnauthorizedException
- if not system admin
StatusLevelException
- if you try to set a null image pathjava.lang.String getImagePath()
java.lang.String getLargeImagePath()
void setLargeImagePath(java.lang.String largeImagePath) throws UnauthorizedException
UnauthorizedException
int getMinPoints()
int getMaxPoints()
void setGroup(Group group) throws UnauthorizedException, StatusLevelException
group
-
UnauthorizedException
StatusLevelException
- if there are minPoints or maxPoints values greater
than -1.Group getGroup()
java.lang.String getProperty(java.lang.String name)
name
- the name of the property to get.
void setProperty(java.lang.String name, java.lang.String value) throws UnauthorizedException
If the property referenced by
name
already exists, its
value will be updated.
name
- the name of the property to set.value
- the new value for the property.
UnauthorizedException
- if not system adminvoid deleteProperty(java.lang.String name) throws UnauthorizedException
name
does not exist, this method will do nothing.
name
- the name of the property to delete.
UnauthorizedException
- if not system adminjava.util.Iterator getPropertyNames()
boolean isInRange(int pointValue)
pointValue
- point value to check
void setPointRange(int minPoints, int maxPoints) throws UnauthorizedException, StatusLevelException
minPoints
- minimum value for the point rangemaxPoints
- maximmum value for the point range
UnauthorizedException
- UnauthorizedException if not system admin
StatusLevelException
- if an illegal point range is specified
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |