Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class RewardsAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.jivesoftware.base.action.JiveActionSupport
          extended by com.jivesoftware.forum.action.ForumActionSupport
              extended by com.jivesoftware.forum.action.RewardsAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.webwork.interceptor.ServletResponseAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable

public class RewardsAction
extends ForumActionSupport
implements com.opensymphony.xwork.Validateable

Modes: 1. Assign points to a topic (assign) 2. Un-assign points to a topic (unassign) 3. Reward points to a message (transfer)

See Also:
Serialized Form

Field Summary
static java.lang.String ASSIGN
           
static java.lang.String ASSIGN_SUCCESS
           
static java.lang.String TRANSFER
           
static java.lang.String TRANSFER_SUCCESS
           
static java.lang.String UNASSIGN
           
static java.lang.String UNASSIGN_SUCCESS
           
 
Fields inherited from class com.jivesoftware.forum.action.ForumActionSupport
CANCEL, DISABLED, FATAL, NOTFOUND, SESSION_REFERRER_KEY, UNAUTHORIZED
 
Fields inherited from class com.jivesoftware.base.action.JiveActionSupport
pageUser, request, response
 
Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
RewardsAction()
           
 
Method Summary
 java.lang.String doDefault()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 java.lang.String getCancel()
           
 Forum getForum()
           
 long getForumID()
           
 int getMaxAssignablePoints()
           
 ForumMessage getMessage()
           
 long getMessageID()
           
 java.lang.String getMode()
           
 int getPoints()
           
 RewardManager getRewardManager()
           
 ForumThread getThread()
           
 long getThreadID()
           
protected  boolean loadJiveObjects()
           
 void setCancel(java.lang.String cancel)
           
protected  void setForum(Forum forum)
           
 void setForumID(long forumID)
           
protected  void setMessage(ForumMessage message)
           
 void setMessageID(long messageID)
           
 void setMode(java.lang.String mode)
           
 void setPoints(int points)
           
protected  void setThread(ForumThread thread)
           
 void setThreadID(long threadID)
           
 void validate()
           
 
Methods inherited from class com.jivesoftware.forum.action.ForumActionSupport
getCanAttach, getCanCreateMessage, getCanCreatePoll, getCanCreatePoll, getCanCreateThread, getCanCreateThread, getCanEdit, getCanEditAttach, getCanEditPoll, getCanEditPoll, getCanEditProfile, getCanEditTags, getCanPostAnnounce, getCanPostAnnounce, getCanRead, getCanRead, getEntityDescriptor, getForumFactory, getPageUser, getReadStatus, getSkinProperty, getThemeName, isAdmin, isAdmin, isAuthor, isAuthor, isMessageModerationOn, isModerator, isModerator, isResourceInTheme, isSystemAdmin, isThreadModerationOn, setForumFactory, setUser
 
Methods inherited from class com.jivesoftware.base.action.JiveActionSupport
getAuthToken, getGuestProperty, getJiveProperty, getLocales, getPageURL, getSession, getText, getText, getTimeZone, getTimeZones, isFailedLookup, isGuest, setAuthToken, setGuestProperty, setLoginAttributes, setPageUser, setServletRequest, setServletResponse
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, pause, setActionErrors, setActionMessages, setFieldErrors
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ASSIGN

public static final java.lang.String ASSIGN
See Also:
Constant Field Values

UNASSIGN

public static final java.lang.String UNASSIGN
See Also:
Constant Field Values

TRANSFER

public static final java.lang.String TRANSFER
See Also:
Constant Field Values

TRANSFER_SUCCESS

public static final java.lang.String TRANSFER_SUCCESS
See Also:
Constant Field Values

ASSIGN_SUCCESS

public static final java.lang.String ASSIGN_SUCCESS
See Also:
Constant Field Values

UNASSIGN_SUCCESS

public static final java.lang.String UNASSIGN_SUCCESS
See Also:
Constant Field Values
Constructor Detail

RewardsAction

public RewardsAction()
Method Detail

getForumID

public long getForumID()

setForumID

public void setForumID(long forumID)

getThreadID

public long getThreadID()

setThreadID

public void setThreadID(long threadID)

getMessageID

public long getMessageID()

setMessageID

public void setMessageID(long messageID)

getMode

public java.lang.String getMode()

setMode

public void setMode(java.lang.String mode)

getPoints

public int getPoints()

setPoints

public void setPoints(int points)

getForum

public Forum getForum()

setForum

protected void setForum(Forum forum)

getThread

public ForumThread getThread()

setThread

protected void setThread(ForumThread thread)

getMessage

public ForumMessage getMessage()

setMessage

protected void setMessage(ForumMessage message)

getCancel

public java.lang.String getCancel()

setCancel

public void setCancel(java.lang.String cancel)

getRewardManager

public RewardManager getRewardManager()

getMaxAssignablePoints

public int getMaxAssignablePoints()

validate

public void validate()
Specified by:
validate in interface com.opensymphony.xwork.Validateable
Overrides:
validate in class com.opensymphony.xwork.ActionSupport

doDefault

public java.lang.String doDefault()
Overrides:
doDefault in class com.opensymphony.xwork.ActionSupport

execute

public java.lang.String execute()
Description copied from class: ForumActionSupport
Default implementation of doExecute() method. This class is intended to be a base class for other actions but can be used as an action itself if the skin author simply wants to get access to the context & methods provided by this class.

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class ForumActionSupport
Returns:
Action.SUCCESS

loadJiveObjects

protected boolean loadJiveObjects()
                           throws UnauthorizedException
Throws:
UnauthorizedException

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.