forumfactory.java

Jive论坛2.5版本的源程序

     */
    public abstract Iterator forums();

    /**
     * Creates a query object to search through all forums. Note: only forums
     * that the user calling this method has read access for will be included
     * in the search.
     *
     * @return a Query object that can be used to search all forums.
     */
    public abstract Query createQuery();

    /**
     * Creates a query object to search through the specified list of forums.
     *
     * @return a Query object that can be used to search the specified forums.
     */
    public abstract Query createQuery(Forum [] forums);

    /**
     * Returns an Iterator for the most popular forums in the system. Popular
     * forums are defined as those that have the most new messages over a
     * period of time (e.g. the last 24 hours).
     *
     * A number of configurable Jive properties control how the popular forums
     * feature works:<ul>
     *      <li> <code>popularForums.number</code> -- The maximum number of
     *          forums that will be returned in the list of popular forums.
     *          Default is 4.
     *      <li> <code>popularForums.timeWindow</code> -- The number of hours
     *          to consider new messages in a thread from. Default is 24 hours,
     *          which is suitable for sites with moderate to high amounts of
     *          traffic. Sites with less traffic may wish to set the window
     *          to a number of days. </ul>
     *
     * @return an Iterator for the most popular forums.
     */
    public abstract Iterator popularForums();

    /**
     * Returns an Iterator for the most threads in the system. Popular
     * threads are defined as those that have the most new messages over a
     * period of time (e.g. the last 24 hours).
     *
     * A number of configurable Jive properties control how the popular threads
     * feature works:<ul>
     *      <li> <code>popularThreads.number</code> -- The number of
     *          threads that will be returned in the list of popular threads.
     *          Default is 4.
     *      <li> <code>popularThreads.timeWindow</code> -- The number of hours
     *          to consider new messages in a thread from. Default is 24 hours,
     *          which is suitable for sites with moderate to high amounts of
     *          traffic. Sites with less traffic may wish to set the window
     *          to a number of days. </ul>
     *
     * @return an Iterator for the most popular forums.
     */
    public abstract Iterator popularThreads();

    /**
     * Deletes a forum and all of its content. This method is not always
     * guaranteed to be safe to call. For example, if multiple clients have
     * handles on a forum, and that forum is subsequently deleted, the behavior
     * of the forum objects that the clients have handles on is unspecified and
     * may result in errors.
     *
     * @param forum the forum to delete.
     * @throws UnauthorizedException if not allowed to delete a forum.
     */
    public abstract void deleteForum(Forum forum)
            throws UnauthorizedException;

    /**
     * Merges the content of two forums by copying the threads from
     * <tt>forum2</tt> to <tt>forum1</tt>. <tt>forum2</tt> will be deleted after
     * all content is merged.<p>
     *
     * You may only execute this operation if you are a system administrator.
     *
     * @param forum1 the Forum to merge threads into.
     * @param forum2 the Forum to move all threads from.
     */
    public abstract void mergeForums(Forum forum1, Forum forum2)
            throws UnauthorizedException;

    /**
     * Returns a UserManager that can be used to manage users.
     *
     * @return a user manager.
     * @see UserManager
     */
    public abstract UserManager getUserManager();

    /**
     * Returns a GroupManager that can be used to manage groups.
     *
     * @return a group manager.
     * @see GroupManager
     */
    public abstract GroupManager getGroupManager();

    /**
     * Returns the search manger which can be used to manage the index used
     * by Jive to perform searches.
     *
     * @throws UnauthorizedException if not a system administator.
     * @return a search manager.
     */
    public abstract SearchManager getSearchManager()
            throws UnauthorizedException;

    /**
     * Returns a filter manager that can be used to manage system wide filters.
     *
     * @return a FilterManager to manage system wide filters.
     */
    public abstract FilterManager getFilterManager();

    /**
     * Returns a watch manager that can be used to manage thread watches.
     *
     * @return a WatchManager to manage thread watches.
     */
    public abstract WatchManager getWatchManager();

    /**
     * Returns a reward manager that can be used to manage reward points.
     *
     * @return a RewardManager to manage reward points.
     */
    public abstract RewardManager getRewardManager();

    /**
     * Returns a permissions manager that can be used to set system wide
     * permissions. Only system admins can perform this function.
     *
     * @return a PermissionsManager to manage the system permissions.
     * @throws UnauthorizedException if not a system admin.
     */
    public abstract PermissionsManager getPermissionsManager()
            throws UnauthorizedException;

    /**
     * Returns an array of ForumMessageFilter objects that represent all the
     * currently available filters in the system. This list is useful when
     * using the FilterManager class.
     *
     * @return an array of all available message filters in the system.
     * @throws UnauthorizedException if not a system admin.
     */
    public abstract ForumMessageFilter [] getAvailableFilters()
            throws UnauthorizedException;

    /**
     * Installs a new class into the list of available filters for the system.
     * Exceptions are thrown if you're not a system admin, the class can't be
     * loaded from the classpath, or the class isn't an instance of
     * ForumMessageFilter.
     *
     * @param className the fully qualified name of the class to add to the list
     *      of available filters in the system.
     * @throws UnauthorizedException if not a system admin
     * @throws ClassNotFoundException if the class could not be loaded.
     * @throws IllegalArgumentException if the class is not a filter or could
     *      not be instantiated.
     */
    public abstract void addFilterClass(String className)
            throws UnauthorizedException, ClassNotFoundException,
            IllegalArgumentException;

    /**
     * Returns the permissions for the factory that correspond to the
     * passed-in Authorization.
     *
     * @param authorization the auth token for the user.
     * @return the permissions for this object.
     */
    public abstract ForumPermissions getPermissions(Authorization authorization);

    /**
     * Returns true if the handle on the object has the permission specified.
     * A list of possible permissions can be found in the ForumPermissions
     * class. Certain methods of this class are restricted to certain
     * permissions as specified in the method comments.
     *
     * @param type the type of permission to check for.
     * @see ForumPermissions
     */
    public abstract boolean hasPermission(int type);
}