Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.profiles.action
Class EditProfileAction

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.profiles.action.ProfileAction
                  extended by com.jivesoftware.profiles.action.EditProfileAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, ProfileFieldManagerAware, ProfileManagerAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.webwork.interceptor.ServletResponseAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.Preparable, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
CreateProfile, EditProfile, EditUserProfile

public abstract class EditProfileAction
extends ProfileAction
implements com.opensymphony.xwork.Preparable

An abstract action that contains all of the logic to create / edit a user profile. This action should be extended to provide the target user.

See Also:
Serialized Form

Field Summary
protected  IntrospectiveUser iUser
           
 
Fields inherited from class com.jivesoftware.profiles.action.ProfileAction
profileFieldManager, profileManager
 
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
EditProfileAction()
           
 
Method Summary
 java.lang.String doCancel()
           
 java.lang.String doInput()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 java.lang.String getAimID()
           
 java.lang.String getEmail()
           
 java.util.List getFields()
           
 IntrospectiveUser getIntrospectiveUser()
           
 java.lang.String getJID()
          Returns the xmpp JID (actually, just the username portion - not the domain) The domain will be that of the currently configured xmpp server.
 java.lang.String getName()
           
 java.util.Map getProfile()
           
 java.util.Map getProfileMap()
          Returns the Map of custom profile fields
 java.lang.String getSignature()
           
protected abstract  User getTargetUser()
           
 boolean isAvatarEditEnabled()
          Returns true if the current user can edit avatars.
 boolean isShowEmail()
           
 boolean isShowName()
           
 boolean isShowSignature()
           
 void prepare()
           
 void setAimID(java.lang.String aimID)
           
 void setEmail(java.lang.String email)
           
 void setJID(java.lang.String jid)
          Sets the xmpp JID.
 void setName(java.lang.String name)
           
 void setProfile(java.util.Map profile)
           
 void setProfileMap(java.util.Map profileMap)
          Sets the local profile map
 void setShowEmail(boolean showEmail)
           
 void setShowName(boolean showName)
           
 void setShowSignature(boolean showSignature)
           
 void setSignature(java.lang.String signature)
           
 void validate()
           
 
Methods inherited from class com.jivesoftware.profiles.action.ProfileAction
setProfileFieldManager, setProfileManager
 
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, doDefault, 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

iUser

protected IntrospectiveUser iUser
Constructor Detail

EditProfileAction

public EditProfileAction()
Method Detail

getTargetUser

protected abstract User getTargetUser()

prepare

public void prepare()
Specified by:
prepare in interface com.opensymphony.xwork.Preparable

validate

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

doCancel

public java.lang.String doCancel()

doInput

public java.lang.String doInput()
Overrides:
doInput 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

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

isShowName

public boolean isShowName()

setShowName

public void setShowName(boolean showName)

getEmail

public java.lang.String getEmail()

setEmail

public void setEmail(java.lang.String email)

isShowEmail

public boolean isShowEmail()

setShowEmail

public void setShowEmail(boolean showEmail)

getSignature

public java.lang.String getSignature()

setSignature

public void setSignature(java.lang.String signature)

getAimID

public java.lang.String getAimID()

setAimID

public void setAimID(java.lang.String aimID)

isShowSignature

public boolean isShowSignature()

setShowSignature

public void setShowSignature(boolean showSignature)

getFields

public java.util.List getFields()

getProfile

public java.util.Map getProfile()

setProfile

public void setProfile(java.util.Map profile)

getIntrospectiveUser

public IntrospectiveUser getIntrospectiveUser()

getJID

public java.lang.String getJID()
Returns the xmpp JID (actually, just the username portion - not the domain) The domain will be that of the currently configured xmpp server.

Returns:
the JID

setJID

public void setJID(java.lang.String jid)
Sets the xmpp JID. The username will be accepted, but any domain information will be stripped

Parameters:
jid -

isAvatarEditEnabled

public boolean isAvatarEditEnabled()
Returns true if the current user can edit avatars.

Returns:
true if the current user can edit avatars.

getProfileMap

public java.util.Map getProfileMap()
Returns the Map of custom profile fields

Returns:
the profile varialbe

setProfileMap

public void setProfileMap(java.util.Map profileMap)
Sets the local profile map

Parameters:
profileMap -

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.