Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.ban
Class BanLevel

java.lang.Object
  extended by com.jivesoftware.base.ban.BanLevel

public class BanLevel
extends java.lang.Object

A typesafe-enum class containing key/value pairs representing BanLevel objects.


Field Summary
static BanLevel[] BAN_LEVELS
          An array containing all possible types of ban levels
static BanLevel BAN_LOGIN
          Users will not be allowed to login to the system
static BanLevel BAN_POST
          Users will not be able to post messages or private messages to the system
static BanLevel MODERATE
          Posts from a user will need to be moderated
 
Method Summary
static BanLevel getBanLevel(int key)
          A helper method to get a specific BanLevel object from its key
 java.lang.String getI18nKey()
          Gets the i18n key of a BanLevel object.
 int getKey()
          Gets the key of a BanLevel object
 java.lang.String getValue()
          Gets the value of a BanLevel object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BAN_LOGIN

public static final BanLevel BAN_LOGIN
Users will not be allowed to login to the system


BAN_POST

public static final BanLevel BAN_POST
Users will not be able to post messages or private messages to the system


MODERATE

public static final BanLevel MODERATE
Posts from a user will need to be moderated


BAN_LEVELS

public static final BanLevel[] BAN_LEVELS
An array containing all possible types of ban levels

Method Detail

getKey

public int getKey()
Gets the key of a BanLevel object

Returns:
the key value representing the BanLevel object

getI18nKey

public java.lang.String getI18nKey()
Gets the i18n key of a BanLevel object.

Returns:
the i18n key of the BanLevel object.

getValue

public java.lang.String getValue()
Gets the value of a BanLevel object

Returns:
the String value representing the BanLevel object

getBanLevel

public static BanLevel getBanLevel(int key)
A helper method to get a specific BanLevel object from its key

Parameters:
key - the key value of the BanLevel object
Returns:
the BanLevel object corresponding to the key value. NULL if the key is invalid.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.