Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.profiles.action.admin
Class EditProfileField

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.admin.EditProfileField
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

public class EditProfileField
extends ProfileAction
implements com.opensymphony.xwork.Preparable

See Also:
Serialized Form

Field Summary
 
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
EditProfileField()
           
 
Method Summary
 java.lang.String doInput()
           
 java.lang.String execute()
          Default implementation of doExecute() method.
 java.lang.String getDescription()
           
 ProfileField getField()
           
 long getFieldID()
           
 java.lang.String getName()
           
 void prepare()
           
 void setDescription(java.lang.String description)
           
 void setEditable(boolean editable)
           
 void setFieldID(long fieldID)
           
 void setFilterable(boolean filterable)
           
 void setName(java.lang.String name)
           
 void setRequired(boolean required)
           
 void setSearchable(boolean searchable)
           
 void setVisible(boolean visible)
           
 void validate()
          Validates the name field exists.
 
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
 

Constructor Detail

EditProfileField

public EditProfileField()
Method Detail

prepare

public void prepare()
             throws java.lang.Exception
Specified by:
prepare in interface com.opensymphony.xwork.Preparable
Throws:
java.lang.Exception

validate

public void validate()
Validates the name field exists.

Specified by:
validate in interface com.opensymphony.xwork.Validateable
Overrides:
validate in class com.opensymphony.xwork.ActionSupport

doInput

public java.lang.String doInput()
                         throws java.lang.Exception
Overrides:
doInput in class com.opensymphony.xwork.ActionSupport
Throws:
java.lang.Exception

execute

public java.lang.String execute()
                         throws java.lang.Exception
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
Throws:
java.lang.Exception

getFieldID

public long getFieldID()

setFieldID

public void setFieldID(long fieldID)

getField

public ProfileField getField()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

setRequired

public void setRequired(boolean required)

setFilterable

public void setFilterable(boolean filterable)

setSearchable

public void setSearchable(boolean searchable)

setVisible

public void setVisible(boolean visible)

setEditable

public void setEditable(boolean editable)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.