com.filenet.wcm.apps.server.util.prefs
Class WcmUserPrefs

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject
      extended bycom.filenet.wcm.apps.server.util.prefs.WcmBasePrefs
          extended bycom.filenet.wcm.apps.server.util.prefs.WcmUserPrefs
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class WcmUserPrefs
extends WcmBasePrefs

See Also:
Serialized Form

Nested Class Summary
static class WcmUserPrefs.Category
           
static class WcmUserPrefs.SelectedSearchTemplate
           
 
Field Summary
static java.lang.String CAT_BROWSE
           
static java.lang.String CAT_ET
           
static java.lang.String CAT_FORMS
           
static java.lang.String CAT_RM
           
static java.lang.String CAT_SEARCH
           
static java.lang.String CAT_WEBCAT
           
static int SHORTCUT_MODE_HIDE
           
static int SHORTCUT_MODE_SHOW_EACH
           
static int SHORTCUT_MODE_SHOW_GROUP
           
protected  java.util.Map shortcuts
           
static java.lang.String USE_DEFAULT_TIMEZONE
           
static com.filenet.wcm.toolkit.util.WcmString wsBrowseShortcuts
           
static com.filenet.wcm.toolkit.util.WcmString wsEntryTemplatesShortcuts
           
static com.filenet.wcm.toolkit.util.WcmString wsFormShortcuts
           
static com.filenet.wcm.toolkit.util.WcmString wsSearchShortcuts
           
 
Fields inherited from class com.filenet.wcm.apps.server.util.prefs.WcmBasePrefs
dateFormat, defaultPrefsObjects, displayConfirmation, expandSystemProperties, homePageView, listViewMode, timeFormat, timeZoneID, USE_CLIENT_TIMEZONE, USE_SERVER_TIMEZONE
 
Constructor Summary
WcmUserPrefs()
           
 
Method Summary
 void addShortcut(WcmShortcut s)
           
 java.util.List getAllCategories()
           
 java.lang.String getBatchType()
           
 int getBrowseShortcutsMode()
           
 java.util.List getCategories(boolean includeEforms)
           
 WcmUserPrefs.Category getCategory(java.lang.String id)
           
 java.lang.String getDefaultFilePlanId()
           
 java.lang.String getDefaultFilePlanName()
           
 java.lang.String getDefaultFilePlanObjectStoreName()
           
 WcmUserQuery getDefaultUserQueryPrefs(int objectType, boolean isFilterQuery)
           
 java.lang.String getEmailAddress()
           
 java.util.List getEntryTemplateShortcuts(int type)
           
 int getFormsShortcutsMode()
           
 java.lang.String getHomePage()
           
 java.util.List getPortalPages()
           
 java.lang.String getPortalPlaceId()
           
 java.util.Map getQuerySettings()
           
 int getRange()
           
 java.lang.String getRelevancyShow()
           
 java.lang.String getSearchInFolderId()
           
 java.lang.String getSearchInFolderName()
           
 java.lang.String getSearchInObjectStore()
           
 java.lang.String getSearchInObjectType()
           
 java.lang.String getSearchScope()
           
 int getSearchShortcutsMode()
           
 WcmUserPrefs.SelectedSearchTemplate getSelectedSearchTemplate()
           
 WcmShortcut getShortcut(java.lang.String key)
           
static java.lang.String getShortcutCategory(java.lang.String objectType, java.lang.String mimeType)
           
 java.util.Map getShortcutMap(java.lang.String category)
           
 java.util.Collection getShortcuts(java.lang.String category)
           
 boolean getShowActionIcons()
           
 boolean getShowCriteriaOnResults()
           
 int getShowFolderFilterAlways()
           
 boolean getShowSearchFor()
           
 int getTemplateShortcutsMode()
           
 java.lang.String getTimeZoneID()
           
 WcmUserQuery getUserQueryPrefs(java.lang.String objectStoreName, int objectType, boolean filter)
           
protected  void initialize()
           
 WcmShortcut removeShortcut(java.lang.String key)
           
protected  void saveToXML(java.io.Writer w)
           
 void setBatchType(java.lang.String newBatchType)
           
 void setBrowseShortcutsMode(int browseShortcutsMode)
           
 void setDefaultFilePlanId(java.lang.String Id)
           
 void setDefaultFilePlanName(java.lang.String filePlan)
           
 void setDefaultFilePlanObjectStoreName(java.lang.String name)
           
 void setEmailAddress(java.lang.String newEmailAddress)
           
 void setFormsShortcutsMode(int formsShortcutsMode)
           
 void setGroupPageSourceId(java.lang.String id)
           
 void setHomePage(java.lang.String newHomePage)
           
 void setRange(int newRange)
           
 void setRelevancyShow(java.lang.String newRelevancyShow)
           
 void setSearchInFolderId(java.lang.String newSearchInFolderPath)
           
 void setSearchInFolderName(java.lang.String newSearchInFolderName)
           
 void setSearchInObjectStore(java.lang.String newSearchInObjectStore)
           
 void setSearchInObjectType(java.lang.String newSearchInObjectType)
           
 void setSearchScope(java.lang.String newSearchScope)
           
 void setSearchShortcutsMode(int searchShortcutsMode)
           
 void setSelectedSearchTemplate(WcmUserPrefs.SelectedSearchTemplate selectedSearchTemplate)
           
 void setShowActionIcons(boolean showActionIcons)
           
 void setShowCriteriaOnResults(boolean newShowCriteriaOnResults)
           
 void setShowFolderFilterAlways(int value)
           
 void setShowSearchFor(boolean value)
           
 void setTemplateShortcutsMode(int templateShortcutsMode)
           
 boolean useDefaultTimeZone()
           
 
Methods inherited from class com.filenet.wcm.apps.server.util.prefs.WcmBasePrefs
getConfirmView, getDateFormat, getDefaultSearchMode, getDetailedPageSize, getExpandSystemProperties, getHomePageView, getListViewMode, getMagazinePageSize, getSelectionTreeMode, getTimeFormat, registerWorkplacePrefsClasses, setConfirmView, setDateFormat, setDefaultPrefsObjects, setDefaultSearchMode, setDetailedPageSize, setExpandSystemProperties, setHomePageView, setListViewMode, setMagazinePageSize, setSelectionTreeMode, setTimeFormat, setTimeZoneID, useClientTimeZone, useServerTimeZone
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject
clear, clearAttributes, clone, convertToBoolean, convertToBoolean, convertToInt, convertToLong, convertToPrefsLabel, convertToPrefsLabelArray, equals, get, getAttribute, getBoolean, getElementKey, getInt, getLabel, getLabelArray, getList, getLocalizedString, getString, getStringArray, getVersion, load, load, load, load, loadLabel, loadPreferences, loadPreferences, loadPreferences, persist, put, put, put, put, put, put, put, put, registerKey, remove, removeAttribute, removeLocalizedString, setAttribute, setElementKey, setVersion, toByteArrayXML, toXML, writeEndSettingTag, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeStartSettingTag, writeStartSettingTag, writeXML, writeXML
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

wsEntryTemplatesShortcuts

public static final com.filenet.wcm.toolkit.util.WcmString wsEntryTemplatesShortcuts

wsFormShortcuts

public static final com.filenet.wcm.toolkit.util.WcmString wsFormShortcuts

wsBrowseShortcuts

public static final com.filenet.wcm.toolkit.util.WcmString wsBrowseShortcuts

wsSearchShortcuts

public static final com.filenet.wcm.toolkit.util.WcmString wsSearchShortcuts

CAT_ET

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

CAT_FORMS

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

CAT_BROWSE

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

CAT_SEARCH

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

CAT_RM

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

CAT_WEBCAT

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

SHORTCUT_MODE_SHOW_GROUP

public static final int SHORTCUT_MODE_SHOW_GROUP
See Also:
Constant Field Values

SHORTCUT_MODE_HIDE

public static final int SHORTCUT_MODE_HIDE
See Also:
Constant Field Values

SHORTCUT_MODE_SHOW_EACH

public static final int SHORTCUT_MODE_SHOW_EACH
See Also:
Constant Field Values

USE_DEFAULT_TIMEZONE

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

shortcuts

protected java.util.Map shortcuts
Constructor Detail

WcmUserPrefs

public WcmUserPrefs()
Method Detail

initialize

protected void initialize()
Overrides:
initialize in class WcmBasePrefs

getShortcuts

public java.util.Collection getShortcuts(java.lang.String category)

getShortcutMap

public java.util.Map getShortcutMap(java.lang.String category)

saveToXML

protected void saveToXML(java.io.Writer w)
                  throws java.io.IOException
Overrides:
saveToXML in class WcmBasePrefs
Throws:
java.io.IOException

getQuerySettings

public java.util.Map getQuerySettings()

getSelectedSearchTemplate

public WcmUserPrefs.SelectedSearchTemplate getSelectedSearchTemplate()

setSelectedSearchTemplate

public void setSelectedSearchTemplate(WcmUserPrefs.SelectedSearchTemplate selectedSearchTemplate)

getShowSearchFor

public boolean getShowSearchFor()

setShowSearchFor

public void setShowSearchFor(boolean value)

getEntryTemplateShortcuts

public java.util.List getEntryTemplateShortcuts(int type)

getShowFolderFilterAlways

public int getShowFolderFilterAlways()

setShowFolderFilterAlways

public void setShowFolderFilterAlways(int value)

getDefaultUserQueryPrefs

public WcmUserQuery getDefaultUserQueryPrefs(int objectType,
                                             boolean isFilterQuery)

getUserQueryPrefs

public WcmUserQuery getUserQueryPrefs(java.lang.String objectStoreName,
                                      int objectType,
                                      boolean filter)

setSearchInFolderName

public void setSearchInFolderName(java.lang.String newSearchInFolderName)

getSearchInFolderName

public java.lang.String getSearchInFolderName()

setSearchInFolderId

public void setSearchInFolderId(java.lang.String newSearchInFolderPath)

getSearchInFolderId

public java.lang.String getSearchInFolderId()

setSearchInObjectType

public void setSearchInObjectType(java.lang.String newSearchInObjectType)

getSearchInObjectType

public java.lang.String getSearchInObjectType()

setSearchInObjectStore

public void setSearchInObjectStore(java.lang.String newSearchInObjectStore)

getSearchInObjectStore

public java.lang.String getSearchInObjectStore()

setRelevancyShow

public void setRelevancyShow(java.lang.String newRelevancyShow)

getRelevancyShow

public java.lang.String getRelevancyShow()

setSearchScope

public void setSearchScope(java.lang.String newSearchScope)

getSearchScope

public java.lang.String getSearchScope()

setBatchType

public void setBatchType(java.lang.String newBatchType)

getBatchType

public java.lang.String getBatchType()

setRange

public void setRange(int newRange)

getRange

public int getRange()

setEmailAddress

public void setEmailAddress(java.lang.String newEmailAddress)

getEmailAddress

public java.lang.String getEmailAddress()

setHomePage

public void setHomePage(java.lang.String newHomePage)

getHomePage

public java.lang.String getHomePage()

getPortalPages

public java.util.List getPortalPages()

getPortalPlaceId

public java.lang.String getPortalPlaceId()

setGroupPageSourceId

public void setGroupPageSourceId(java.lang.String id)

getShowActionIcons

public boolean getShowActionIcons()

setShowActionIcons

public void setShowActionIcons(boolean showActionIcons)

getShowCriteriaOnResults

public boolean getShowCriteriaOnResults()

setShowCriteriaOnResults

public void setShowCriteriaOnResults(boolean newShowCriteriaOnResults)

getAllCategories

public java.util.List getAllCategories()

getCategories

public java.util.List getCategories(boolean includeEforms)

getCategory

public WcmUserPrefs.Category getCategory(java.lang.String id)

getSearchShortcutsMode

public int getSearchShortcutsMode()

setSearchShortcutsMode

public void setSearchShortcutsMode(int searchShortcutsMode)

getBrowseShortcutsMode

public int getBrowseShortcutsMode()

setBrowseShortcutsMode

public void setBrowseShortcutsMode(int browseShortcutsMode)

getFormsShortcutsMode

public int getFormsShortcutsMode()

setFormsShortcutsMode

public void setFormsShortcutsMode(int formsShortcutsMode)

getTemplateShortcutsMode

public int getTemplateShortcutsMode()

setTemplateShortcutsMode

public void setTemplateShortcutsMode(int templateShortcutsMode)

getDefaultFilePlanName

public java.lang.String getDefaultFilePlanName()

setDefaultFilePlanName

public void setDefaultFilePlanName(java.lang.String filePlan)

getDefaultFilePlanId

public java.lang.String getDefaultFilePlanId()

setDefaultFilePlanId

public void setDefaultFilePlanId(java.lang.String Id)

getDefaultFilePlanObjectStoreName

public java.lang.String getDefaultFilePlanObjectStoreName()

setDefaultFilePlanObjectStoreName

public void setDefaultFilePlanObjectStoreName(java.lang.String name)

addShortcut

public void addShortcut(WcmShortcut s)

removeShortcut

public WcmShortcut removeShortcut(java.lang.String key)

getShortcut

public WcmShortcut getShortcut(java.lang.String key)

getShortcutCategory

public static java.lang.String getShortcutCategory(java.lang.String objectType,
                                                   java.lang.String mimeType)

getTimeZoneID

public java.lang.String getTimeZoneID()
Overrides:
getTimeZoneID in class WcmBasePrefs

useDefaultTimeZone

public boolean useDefaultTimeZone()


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.