com.actuate.activeportal.forms
Class UserOptionsActionForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by com.actuate.activeportal.forms.BaseActionForm
          extended by com.actuate.activeportal.forms.UserOptionsActionForm
All Implemented Interfaces:
java.io.Serializable

public class UserOptionsActionForm
extends BaseActionForm

This is the session beans that stores user options when the options page is visited.

See Also:
Serialized Form

Field Summary
static java.lang.String[] TABNAMES_KEY
          User Interface tab names (also used as JSP file names)
 
Constructor Summary
UserOptionsActionForm()
           
 
Method Summary
 void fixUTF8()
          Converts the form properties which is in UTF-8 encoding to internal Java String.
 java.util.Collection getAnalyticsExpLevels()
          Returns list of analytics exp levels that the user can use
 java.lang.String getConfirmKey()
          Returns the password confirmation.
 java.lang.String getCurrentAnalyticsExpLevel()
          Returns current analytics experience level name for the user
 java.lang.String getCurrentSkin()
          Returns current skin.
 java.lang.String getCurrentView()
          Returns current view.
 java.lang.String getEmail()
          Returns the user email.
 java.lang.String getIportalVersion()
          Returns the iportalVersion.
 java.lang.String getNewKey()
          Returns the new password
 java.lang.String getOldKey()
          Returns the oldKey.
 java.lang.String getPreviousTab()
          Returns the previousTab.
 int getSecurityIntegrationOption()
          Returns the securityIntegrationOption.
 java.lang.String getSelectedTab()
          Returns the selectedTab.
 java.util.Collection getSkins()
          Returns the skins available to the users.
 java.lang.String getSystemName()
          Returns the systemName.
 java.lang.String getSystemVersion()
          Returns the systemVersion.
 java.util.Collection getViews()
          Returns the views available for the users.
 boolean isCanChangePassword()
          Returns if user can change password or not from UI
 boolean isEmailChanged()
          Test if the user email is changed.
 boolean isFailComp()
          Returns the notification settings
 boolean isFailEmail()
          Returns the notification settings
 boolean isInitialized()
          Returns the initialized.
 boolean isShowFilters()
          Returns the filter settings
 boolean isSuccComp()
          Returns the succComp.
 boolean isSuccEmail()
          Returns the succEmail.
 boolean isUserPropertiesChanged()
          Test is a user property is changed.
 boolean isViewNewBrowserWindow()
          Returns the viewNewBrowserWindow.
 void loadTab(java.lang.String tab)
          Restore saved boolean attributes for a tab.
 void populateBooleans()
          Used internally when switching between tabs.
 void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
           
 void restoreBoolean()
          Used internally when switching between tabs.
 void saveTab(java.lang.String tab)
          Save boolean attributes for a tab.
 void setAnalyticsExpLevels(java.util.Collection _analyticsExpLevels)
          Sets list of analytics exp levels that the user can use
 void setCanChangePassword(boolean b)
          Sets if user can change password or not from UI
 void setConfirmKey(java.lang.String confirmKey)
          Sets the confirmKey.
 void setCurrentAnalyticsExpLevel(java.lang.String _currentAnalyticsExpLevel)
          Sets current analytics experience level name for the user
 void setCurrentSkin(java.lang.String string)
          Sets current skin.
 void setCurrentView(java.lang.String string)
          Sets current view.
 void setEmail(java.lang.String email)
          Sets the email.
 void setFailComp(boolean failComp)
          Sets the failComp.
 void setFailEmail(boolean failEmail)
          Sets the failEmail.
 void setInitialized(boolean initialized)
          Sets the initialized.
 void setIportalVersion(java.lang.String iportalVersion)
          Sets the iportalVersion.
 void setNewKey(java.lang.String newKey)
          Sets the newKey.
 void setOldKey(java.lang.String oldKey)
          Sets the oldKey.
 void setOriginalEmail(java.lang.String string)
          Sets the user email.
 void setOriginalFailComp(boolean b)
          Sets the notification settings
 void setOriginalFailEmail(boolean b)
          Sets the notification settings
 void setOriginalSuccComp(boolean b)
          Sets the notification settings
 void setOriginalSuccEmail(boolean b)
          Sets the notification settings
 void setPreviousTab(java.lang.String previousTab)
          Sets the previousTab.
 void setSecurityIntegrationOption(int securityIntegrationOption)
          Sets the securityIntegrationOption.
 void setSelectedTab(java.lang.String selectedTab)
          Sets the selectedTab.
 void setShowFilters(boolean docChanFilters)
          Sets the showFilters.
 void setSkins(java.util.Collection _skins)
          Sets the skins available to the users.
 void setSuccComp(boolean succComp)
          Sets the succComp.
 void setSuccEmail(boolean succEmail)
          Sets the succEmail.
 void setSystemName(java.lang.String systemName)
          Sets the systemName.
 void setSystemVersion(java.lang.String systemVersion)
          Sets the systemVersion.
 void setViewNewBrowserWindow(boolean viewNewBrowserWindow)
          Sets the viewNewBrowserWindow.
 void setViews(java.util.Collection collection)
          Sets the views available for the users.
 
Methods inherited from class com.actuate.activeportal.forms.BaseActionForm
isPostback, setPostback
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate, validate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TABNAMES_KEY

public static java.lang.String[] TABNAMES_KEY
User Interface tab names (also used as JSP file names)

Constructor Detail

UserOptionsActionForm

public UserOptionsActionForm()
Method Detail

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)
Overrides:
reset in class org.apache.struts.action.ActionForm

saveTab

public void saveTab(java.lang.String tab)
Save boolean attributes for a tab.

Parameters:
tab - a tab name

loadTab

public void loadTab(java.lang.String tab)
Restore saved boolean attributes for a tab.


populateBooleans

public void populateBooleans()
Used internally when switching between tabs.


restoreBoolean

public void restoreBoolean()
Used internally when switching between tabs.


fixUTF8

public void fixUTF8()
Converts the form properties which is in UTF-8 encoding to internal Java String.

Overrides:
fixUTF8 in class BaseActionForm

getConfirmKey

public java.lang.String getConfirmKey()
Returns the password confirmation.

Returns:
String the password confirmation

isShowFilters

public boolean isShowFilters()
Returns the filter settings

Returns:
boolean the filter settings

getEmail

public java.lang.String getEmail()
Returns the user email.

Returns:
String the email address

isFailComp

public boolean isFailComp()
Returns the notification settings

Returns:
boolean

isFailEmail

public boolean isFailEmail()
Returns the notification settings

Returns:
boolean

getNewKey

public java.lang.String getNewKey()
Returns the new password

Returns:
String the new password

getOldKey

public java.lang.String getOldKey()
Returns the oldKey.

Returns:
String

getSelectedTab

public java.lang.String getSelectedTab()
Returns the selectedTab.

Returns:
String

isSuccComp

public boolean isSuccComp()
Returns the succComp.

Returns:
boolean

isSuccEmail

public boolean isSuccEmail()
Returns the succEmail.

Returns:
boolean

isViewNewBrowserWindow

public boolean isViewNewBrowserWindow()
Returns the viewNewBrowserWindow.

Returns:
boolean

setConfirmKey

public void setConfirmKey(java.lang.String confirmKey)
Sets the confirmKey.

Parameters:
confirmKey - The confirmKey to set

setShowFilters

public void setShowFilters(boolean docChanFilters)
Sets the showFilters.

Parameters:
docChanFilters - The showFilters to set

setEmail

public void setEmail(java.lang.String email)
Sets the email.

Parameters:
email - The email to set

setFailComp

public void setFailComp(boolean failComp)
Sets the failComp.

Parameters:
failComp - The failComp to set

setFailEmail

public void setFailEmail(boolean failEmail)
Sets the failEmail.

Parameters:
failEmail - The failEmail to set

setNewKey

public void setNewKey(java.lang.String newKey)
Sets the newKey.

Parameters:
newKey - The newKey to set

setOldKey

public void setOldKey(java.lang.String oldKey)
Sets the oldKey.

Parameters:
oldKey - The oldKey to set

setSelectedTab

public void setSelectedTab(java.lang.String selectedTab)
Sets the selectedTab.

Parameters:
selectedTab - The selectedTab to set

setSuccComp

public void setSuccComp(boolean succComp)
Sets the succComp.

Parameters:
succComp - The succComp to set

setSuccEmail

public void setSuccEmail(boolean succEmail)
Sets the succEmail.

Parameters:
succEmail - The succEmail to set

setViewNewBrowserWindow

public void setViewNewBrowserWindow(boolean viewNewBrowserWindow)
Sets the viewNewBrowserWindow.

Parameters:
viewNewBrowserWindow - The viewNewBrowserWindow to set

isInitialized

public boolean isInitialized()
Returns the initialized.

Returns:
boolean the status indicating if the form is initialized.

setInitialized

public void setInitialized(boolean initialized)
Sets the initialized.

Parameters:
initialized - the status indicating if the form is initialized.

getPreviousTab

public java.lang.String getPreviousTab()
Returns the previousTab.

Returns:
String

setPreviousTab

public void setPreviousTab(java.lang.String previousTab)
Sets the previousTab.

Parameters:
previousTab - The previousTab to set

getSystemName

public java.lang.String getSystemName()
Returns the systemName.

Returns:
String

getSystemVersion

public java.lang.String getSystemVersion()
Returns the systemVersion.

Returns:
String

getIportalVersion

public java.lang.String getIportalVersion()
Returns the iportalVersion.

Returns:
String

setSystemName

public void setSystemName(java.lang.String systemName)
Sets the systemName.

Parameters:
systemName - The systemName to set

setSystemVersion

public void setSystemVersion(java.lang.String systemVersion)
Sets the systemVersion.

Parameters:
systemVersion - The systemVersion to set

setIportalVersion

public void setIportalVersion(java.lang.String iportalVersion)
Sets the iportalVersion.

Parameters:
iportalVersion - The iportalVersion to set

getSecurityIntegrationOption

public int getSecurityIntegrationOption()
Returns the securityIntegrationOption.

Returns:
int

setSecurityIntegrationOption

public void setSecurityIntegrationOption(int securityIntegrationOption)
Sets the securityIntegrationOption.

Parameters:
securityIntegrationOption - The securityIntegrationOption to set

isEmailChanged

public boolean isEmailChanged()
Test if the user email is changed.


setOriginalEmail

public void setOriginalEmail(java.lang.String string)
Sets the user email.


getCurrentSkin

public java.lang.String getCurrentSkin()
Returns current skin.


getCurrentView

public java.lang.String getCurrentView()
Returns current view.


setCurrentSkin

public void setCurrentSkin(java.lang.String string)
Sets current skin.


setCurrentView

public void setCurrentView(java.lang.String string)
Sets current view.


getSkins

public java.util.Collection getSkins()
Returns the skins available to the users.


setSkins

public void setSkins(java.util.Collection _skins)
Sets the skins available to the users.


getCurrentAnalyticsExpLevel

public java.lang.String getCurrentAnalyticsExpLevel()
Returns current analytics experience level name for the user


setCurrentAnalyticsExpLevel

public void setCurrentAnalyticsExpLevel(java.lang.String _currentAnalyticsExpLevel)
Sets current analytics experience level name for the user


getAnalyticsExpLevels

public java.util.Collection getAnalyticsExpLevels()
Returns list of analytics exp levels that the user can use


setAnalyticsExpLevels

public void setAnalyticsExpLevels(java.util.Collection _analyticsExpLevels)
Sets list of analytics exp levels that the user can use


getViews

public java.util.Collection getViews()
Returns the views available for the users.


setViews

public void setViews(java.util.Collection collection)
Sets the views available for the users.


isUserPropertiesChanged

public boolean isUserPropertiesChanged()
Test is a user property is changed.

Returns:
boolean value indicating if the user property is changed.

setOriginalFailComp

public void setOriginalFailComp(boolean b)
Sets the notification settings


setOriginalFailEmail

public void setOriginalFailEmail(boolean b)
Sets the notification settings


setOriginalSuccComp

public void setOriginalSuccComp(boolean b)
Sets the notification settings


setOriginalSuccEmail

public void setOriginalSuccEmail(boolean b)
Sets the notification settings


isCanChangePassword

public boolean isCanChangePassword()
Returns if user can change password or not from UI


setCanChangePassword

public void setCanChangePassword(boolean b)
Sets if user can change password or not from UI