Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer
Interface ForumRenderManager

All Superinterfaces:
RenderManager
All Known Implementing Classes:
ForumRenderManagerProxy, JiveRenderManager

public interface ForumRenderManager
extends RenderManager

A manager to manage filters to be used for render operations. This manager is an extension of the RenderManager interface and contains two methods for managing forum level filters.

See Also:
RenderManager

Method Summary
 void copyGlobalFilters()
          Copy all global filters to the current context.
 void removeAllFilters()
          Removes all filters from the current context.
 
Methods inherited from interface com.jivesoftware.forum.renderer.RenderManager
addFilterRenderTypes, addRenderFilter, getFilterRenderTypes, getInheritedRenderFilters, getRenderFilter, getRenderFilterCount, getRenderFilters, removeFilterRenderTypes, removeRenderFilter, render, render, save
 

Method Detail

copyGlobalFilters

void copyGlobalFilters()
                       throws java.lang.IllegalStateException,
                              UnauthorizedException
Copy all global filters to the current context. If the current context already has 1 or more filters configured an IllegalStateException will be thrown.

Specified by:
copyGlobalFilters in interface RenderManager
Throws:
java.lang.IllegalStateException - if the current context already has 1 or more filters configured
UnauthorizedException - if not an admin

removeAllFilters

void removeAllFilters()
                      throws UnauthorizedException
Removes all filters from the current context.

Specified by:
removeAllFilters in interface RenderManager
Throws:
UnauthorizedException - if not an admin

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.