Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.ban
Interface BanDAO

All Known Implementing Classes:
BanDAOImpl

public interface BanDAO

Defines methods used to create, access, update, and remove ban data objects.

See Also:
Ban, BanFilter

Method Summary
 void createBan(Ban ban)
          Creates a ticket entry in the database
 Ban getBan(long userID, BanLevel banLevel)
          Gets a Ban Object from the database.
 Ban getBan(java.lang.String ipAddress, BanLevel banLevel)
          Gets a Ban Object from the database.
 java.util.List getBans()
          Gets an unfiltered list of Ban objects from database
 java.util.List getBans(BanFilter filter)
          Gets a filtered list of Ban objects from the database
 void removeBan(long banID)
          Removes a Ban entry from the database
 void updateBan(Ban ban)
          Updates a ticket entry in the database
 

Method Detail

createBan

void createBan(Ban ban)
Creates a ticket entry in the database

Parameters:
ban - the ticket to create

updateBan

void updateBan(Ban ban)
Updates a ticket entry in the database

Parameters:
ban - the ticket to update

removeBan

void removeBan(long banID)
Removes a Ban entry from the database

Parameters:
banID - the id of the ban to remove

getBan

Ban getBan(long userID,
           BanLevel banLevel)
Gets a Ban Object from the database.

Parameters:
userID - userID the ID of the user
banLevel - the level of the ban
Returns:
the Ban object if one exists; null otherwise.

getBan

Ban getBan(java.lang.String ipAddress,
           BanLevel banLevel)
Gets a Ban Object from the database.

Parameters:
ipAddress - the IP Address of the ban
banLevel - the level of the ban
Returns:
the Ban object if one exists; null otherwise.

getBans

java.util.List getBans()
Gets an unfiltered list of Ban objects from database

Returns:
a list of Ban objects

getBans

java.util.List getBans(BanFilter filter)
Gets a filtered list of Ban objects from the database

Parameters:
filter - the BanFilter object
Returns:
a filtered list of Ban objects
See Also:
Ban

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.