Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.interceptor
Class ModerationInterceptor

java.lang.Object
  extended by com.jivesoftware.forum.interceptor.ModerationInterceptor
All Implemented Interfaces:
MessageInterceptor

public class ModerationInterceptor
extends java.lang.Object
implements MessageInterceptor


Field Summary
 
Fields inherited from interface com.jivesoftware.forum.MessageInterceptor
TYPE_ALL, TYPE_BOTH, TYPE_EDIT, TYPE_POST, TYPE_PRE
 
Constructor Summary
ModerationInterceptor()
           
ModerationInterceptor(int objectType, long objectID)
           
 
Method Summary
 java.lang.String getAlwaysModeratedGroups()
           
 java.lang.String getAlwaysModeratedUsers()
           
 java.lang.String getNeverModeratedGroups()
           
 java.lang.String getNeverModeratedUsers()
           
 int getType()
          Returns the type of the interceptor.
 void invokeInterceptor(ForumMessage message, int type)
          Invokes the interceptor on the specified message.
 void setAlwaysModeratedGroups(java.lang.String groups)
           
 void setAlwaysModeratedUsers(java.lang.String users)
           
 void setNeverModeratedGroups(java.lang.String groups)
           
 void setNeverModeratedUsers(java.lang.String users)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ModerationInterceptor

public ModerationInterceptor()

ModerationInterceptor

public ModerationInterceptor(int objectType,
                             long objectID)
Method Detail

getAlwaysModeratedGroups

public java.lang.String getAlwaysModeratedGroups()

setAlwaysModeratedGroups

public void setAlwaysModeratedGroups(java.lang.String groups)

getNeverModeratedGroups

public java.lang.String getNeverModeratedGroups()

setNeverModeratedGroups

public void setNeverModeratedGroups(java.lang.String groups)

getAlwaysModeratedUsers

public java.lang.String getAlwaysModeratedUsers()

setAlwaysModeratedUsers

public void setAlwaysModeratedUsers(java.lang.String users)

getNeverModeratedUsers

public java.lang.String getNeverModeratedUsers()

setNeverModeratedUsers

public void setNeverModeratedUsers(java.lang.String users)

getType

public int getType()
Description copied from interface: MessageInterceptor
Returns the type of the interceptor.

Specified by:
getType in interface MessageInterceptor
Returns:
the interceptor type.

invokeInterceptor

public void invokeInterceptor(ForumMessage message,
                              int type)
                       throws MessageRejectedException
Description copied from interface: MessageInterceptor
Invokes the interceptor on the specified message. The interceptor can either modify the message, or throw a MessageRejectedException to block it from being posted. Only a TYPE_PRE interceptor can throw an exception.

Specified by:
invokeInterceptor in interface MessageInterceptor
Parameters:
message - the message to take action on.
Throws:
MessageRejectedException - if the message should be prevented from being posted.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.