Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class EditWatchesAction

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.EditWatchesAction
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 EditWatchesAction
extends ForumActionSupport

An action that encapsulates all the logic for editing user's watches.

See Also:
Serialized Form

Field Summary
static int FREQUENCY_EVERY_OTHER_DAY
          Batch email frequency -- every other day
static int FREQUENCY_IMMEDIATELY
          Batch email frequency -- send immediately (default)
static int FREQUENCY_ONCE_A_DAY
          Batch email frequency -- once a day
static int FREQUENCY_ONCE_A_WEEK
          Batch email frequency -- once a week
protected  boolean updateGeneral
           
 
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
EditWatchesAction()
           
 
Method Summary
 java.lang.String doDefault()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 boolean getHasEmailWatch(java.lang.Object obj)
           
protected  java.util.List getIDs(java.lang.String type, java.lang.String objectType)
           
 IntrospectiveUser getIntrospectiveUser()
          Returns the current user as an IntrospectiveUser.
 boolean getIsExpirableWatch(java.lang.Object obj)
           
 java.util.Iterator getUserMessages(User user)
           
 java.util.Iterator getWatchedCategories()
           
 int getWatchedCategoryCount()
           
 int getWatchedForumCount()
           
 java.util.Iterator getWatchedForums()
           
 int getWatchedThreadCount()
           
 java.util.Iterator getWatchedThreads()
           
 int getWatchedUserCount()
           
 java.util.Iterator getWatchedUsers()
           
 int getWatchFrequency()
           
 WatchManager getWatchManager()
           
 boolean isAlwaysWatchNewTopics()
           
 boolean isAlwaysWatchReplies()
           
 void setAlwaysWatchNewTopics(boolean alwaysWatchNewTopics)
           
 void setAlwaysWatchReplies(boolean alwaysWatchReplies)
           
 void setDeleteCatWatch(java.lang.String deleteCatWatch)
           
 void setDeleteForumWatch(java.lang.String deleteForumWatch)
           
 void setDeleteThreadWatch(java.lang.String deleteThreadWatch)
           
 void setDeleteUserWatch(java.lang.String deleteUserWatch)
           
 void setUpdateCatWatch(java.lang.String updateCatWatch)
           
 void setUpdateForumWatch(java.lang.String updateForumWatch)
           
 void setUpdateGeneral(java.lang.String updateGeneral)
           
 void setUpdateThreadWatch(java.lang.String updateThreadWatch)
           
 void setUpdateUserWatch(java.lang.String updateUserWatch)
           
 void setWatchFrequency(int watchFrequency)
           
protected  void setWatchManager(WatchManager manager)
           
 
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, validate
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FREQUENCY_IMMEDIATELY

public static final int FREQUENCY_IMMEDIATELY
Batch email frequency -- send immediately (default)

See Also:
Constant Field Values

FREQUENCY_ONCE_A_DAY

public static final int FREQUENCY_ONCE_A_DAY
Batch email frequency -- once a day

See Also:
Constant Field Values

FREQUENCY_EVERY_OTHER_DAY

public static final int FREQUENCY_EVERY_OTHER_DAY
Batch email frequency -- every other day

See Also:
Constant Field Values

FREQUENCY_ONCE_A_WEEK

public static final int FREQUENCY_ONCE_A_WEEK
Batch email frequency -- once a week

See Also:
Constant Field Values

updateGeneral

protected boolean updateGeneral
Constructor Detail

EditWatchesAction

public EditWatchesAction()
Method Detail

setUpdateCatWatch

public void setUpdateCatWatch(java.lang.String updateCatWatch)

setDeleteCatWatch

public void setDeleteCatWatch(java.lang.String deleteCatWatch)

setUpdateForumWatch

public void setUpdateForumWatch(java.lang.String updateForumWatch)

setDeleteForumWatch

public void setDeleteForumWatch(java.lang.String deleteForumWatch)

setUpdateThreadWatch

public void setUpdateThreadWatch(java.lang.String updateThreadWatch)

setDeleteThreadWatch

public void setDeleteThreadWatch(java.lang.String deleteThreadWatch)

setUpdateUserWatch

public void setUpdateUserWatch(java.lang.String updateUserWatch)

setDeleteUserWatch

public void setDeleteUserWatch(java.lang.String deleteUserWatch)

isAlwaysWatchNewTopics

public boolean isAlwaysWatchNewTopics()

setAlwaysWatchNewTopics

public void setAlwaysWatchNewTopics(boolean alwaysWatchNewTopics)

isAlwaysWatchReplies

public boolean isAlwaysWatchReplies()

setAlwaysWatchReplies

public void setAlwaysWatchReplies(boolean alwaysWatchReplies)

getWatchFrequency

public int getWatchFrequency()

setWatchFrequency

public void setWatchFrequency(int watchFrequency)

setUpdateGeneral

public void setUpdateGeneral(java.lang.String updateGeneral)

getWatchManager

public WatchManager getWatchManager()

setWatchManager

protected void setWatchManager(WatchManager manager)

getWatchedCategories

public java.util.Iterator getWatchedCategories()

getWatchedCategoryCount

public int getWatchedCategoryCount()

getWatchedForums

public java.util.Iterator getWatchedForums()

getWatchedForumCount

public int getWatchedForumCount()

getWatchedThreads

public java.util.Iterator getWatchedThreads()

getWatchedThreadCount

public int getWatchedThreadCount()

getWatchedUsers

public java.util.Iterator getWatchedUsers()

getWatchedUserCount

public int getWatchedUserCount()

getHasEmailWatch

public boolean getHasEmailWatch(java.lang.Object obj)

getIsExpirableWatch

public boolean getIsExpirableWatch(java.lang.Object obj)

doDefault

public java.lang.String doDefault()
Overrides:
doDefault in class com.opensymphony.xwork.ActionSupport
Returns:
Action.ERROR if there was a problem loading Jive objects, Action.INPUT otherwise.

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.ERROR if there was a problem loading Jive objects or Action.SUCCESS after executing watch edit logic.

getIntrospectiveUser

public IntrospectiveUser getIntrospectiveUser()
Returns the current user as an IntrospectiveUser.

Returns:
the current user as an IntrospectiveUser.

getUserMessages

public java.util.Iterator getUserMessages(User user)

getIDs

protected java.util.List getIDs(java.lang.String type,
                                java.lang.String objectType)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.