com.mf.roundhouse.core.util
Class FeedbackHook

java.lang.Object
  com.mf.roundhouse.core.util.FeedbackHook

Direct Known Subclasses:

EMailFeedbackHook, RatingFeedbackHook

public abstract class FeedbackHook

extends java.lang.Object

Utility class generated by content modules to declare types of interactive feedback behavior that can be associated with content types.

Author:

Jeffrey Payne

Constructor Summary

FeedbackHook()

Method Summary

abstract java.lang.String	getHookIdentifier() A unique string identifying this feeback hook.
abstract java.lang.String	getHookName()
abstract void	renderHook(HttpServletRequest request, HttpServletResponse response, java.io.Writer writer, FeedbackHookConfiguration config, RoundhouseObject object) Renders a link to this feedback hook's behavior, preferably by including a JSP.
abstract void	renderHookExtended(HttpServletRequest request, HttpServletResponse response, java.io.Writer writer, FeedbackHookConfiguration config, RoundhouseObject object) Should render a detailed view of the interactive content represented by this hook.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FeedbackHook

public FeedbackHook()

Method Detail

getHookName

public abstract java.lang.String getHookName()

getHookIdentifier

public abstract java.lang.String getHookIdentifier()

A unique string identifying this feeback hook.

Returns:

renderHook

public abstract void renderHook(HttpServletRequest request,
                                HttpServletResponse response,
                                java.io.Writer writer,
                                FeedbackHookConfiguration config,
                                RoundhouseObject object)
                         throws java.lang.Exception

Renders a link to this feedback hook's behavior, preferably by including a JSP.

Parameters:

object -

Returns:

Throws:

java.lang.Exception

renderHookExtended

public abstract void renderHookExtended(HttpServletRequest request,
                                        HttpServletResponse response,
                                        java.io.Writer writer,
                                        FeedbackHookConfiguration config,
                                        RoundhouseObject object)
                                 throws java.lang.Exception

Should render a detailed view of the interactive content represented by this hook. For example, a discussion feedback hook would display a basic link in renderHook() and a detailed view of the existing threads in renderHookExtended(), preferably by including a JSP.

Parameters:

object -

Returns:

Throws:

java.lang.Exception