Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.ban
Class BanFilter

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

public class BanFilter
extends java.lang.Object

Filters and sorts lists of ban objects. This allows for a very rich set of possible queries that can be run on ban data.


Field Summary
static int ASCENDING
          Ascending sort (ie 3, 4, 5...).
static int CREATION_DATE
          An integer value that represents the modification date filed.
static int DESCENDING
          Descending sort (ie 3, 2, 1...).
static int EXPIRATION_DATE
          An integer value that represents the creation date filed.
 
Constructor Summary
BanFilter()
           
 
Method Summary
static BanFilter createDefaultBanFilter()
          Creates a default BanFilter: no filtering with results sorted by expiration date in descending order.
 long getAdminID()
           
 int getBanLevel()
           
 long getBannedUserID()
           
 int getBanType()
           
 java.util.Date getCreationDateRangeMax()
           
 java.util.Date getCreationDateRangeMin()
           
 java.util.Date getExpirationDateRangeMax()
           
 java.util.Date getExpirationDateRangeMin()
           
 java.lang.String getIpAddress()
           
 int getSortField()
           
 int getSortOrder()
           
 void setAdminID(long adminID)
           
 void setBanLevel(int banLevel)
           
 void setBannedUserID(long bannedUserID)
           
 void setBanType(int banType)
           
 void setCreationDateRangeMax(java.util.Date creationDateRangeMax)
           
 void setCreationDateRangeMin(java.util.Date creationDateRangeMin)
           
 void setExpirationDateRangeMax(java.util.Date expirationDateRangeMax)
           
 void setExpirationDateRangeMin(java.util.Date expirationDateRangeMin)
           
 void setIpAddress(java.lang.String ipAddress)
           
 void setSortField(int sortField)
           
 void setSortOrder(int sortOrder)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DESCENDING

public static final int DESCENDING
Descending sort (ie 3, 2, 1...).

See Also:
Constant Field Values

ASCENDING

public static final int ASCENDING
Ascending sort (ie 3, 4, 5...).

See Also:
Constant Field Values

EXPIRATION_DATE

public static final int EXPIRATION_DATE
An integer value that represents the creation date filed.

See Also:
Constant Field Values

CREATION_DATE

public static final int CREATION_DATE
An integer value that represents the modification date filed.

See Also:
Constant Field Values
Constructor Detail

BanFilter

public BanFilter()
Method Detail

createDefaultBanFilter

public static BanFilter createDefaultBanFilter()
Creates a default BanFilter: no filtering with results sorted by expiration date in descending order.


getSortField

public int getSortField()

setSortField

public void setSortField(int sortField)

getSortOrder

public int getSortOrder()

setSortOrder

public void setSortOrder(int sortOrder)

getBanType

public int getBanType()

setBanType

public void setBanType(int banType)

getBannedUserID

public long getBannedUserID()

setBannedUserID

public void setBannedUserID(long bannedUserID)

getIpAddress

public java.lang.String getIpAddress()

setIpAddress

public void setIpAddress(java.lang.String ipAddress)

getAdminID

public long getAdminID()

setAdminID

public void setAdminID(long adminID)

getBanLevel

public int getBanLevel()

setBanLevel

public void setBanLevel(int banLevel)

getCreationDateRangeMin

public java.util.Date getCreationDateRangeMin()

setCreationDateRangeMin

public void setCreationDateRangeMin(java.util.Date creationDateRangeMin)

getCreationDateRangeMax

public java.util.Date getCreationDateRangeMax()

setCreationDateRangeMax

public void setCreationDateRangeMax(java.util.Date creationDateRangeMax)

getExpirationDateRangeMin

public java.util.Date getExpirationDateRangeMin()

setExpirationDateRangeMin

public void setExpirationDateRangeMin(java.util.Date expirationDateRangeMin)

getExpirationDateRangeMax

public java.util.Date getExpirationDateRangeMax()

setExpirationDateRangeMax

public void setExpirationDateRangeMax(java.util.Date expirationDateRangeMax)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.