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

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.prefs.WcmConfiguration
      extended bycom.filenet.wcm.apps.server.util.prefs.WcmWorkplaceConfig
All Implemented Interfaces:
java.io.Serializable, com.filenet.wcm.toolkit.server.base.WcmConfigurationInterface

public class WcmWorkplaceConfig
extends com.filenet.wcm.toolkit.server.util.prefs.WcmConfiguration

See Also:
Serialized Form

Field Summary
static int CONFIRM_DEFAULT
           
static int CONFIRM_HIDE
           
static int CONFIRM_SHOW
           
static int EXPAND_DEFAULT
           
static int EXPAND_NO
           
static int EXPAND_YES
           
static int LIST_VIEW_MODE_DEFAULT
           
static int LIST_VIEW_MODE_DETAIL
           
static int LIST_VIEW_MODE_MAGAZINE
           
protected  java.util.Locale locale
           
static int SEARCH_MODE_DEFAULT
           
static int SEARCH_MODE_SIMPLE
           
static int SEARCH_MODE_TEMPLATE
           
static int TREE_VIEW_MODE_DEFAULT
           
static int TREE_VIEW_MODE_FLAT
           
static int TREE_VIEW_MODE_TREE
           
static com.filenet.wcm.toolkit.util.WcmString wsNameUndefined
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.prefs.WcmConfiguration
APPLICATION_ENGINE_ADMINS, appName, basePath, bootstrap, bUseLocalFile, configFilePath, credentials, dataStore, ENABLE_DEBUG_TRACE, objectStoreName, PREFS_DOCUMENT_CLASS, PREFS_DOCUMENT_CLASS_ID, PREFS_FILE_NAME, PREFS_FOLDER_CLASS, PREFS_FOLDER_NAME, PREFS_MIME_TYPE, prefsFoldersExist, session, sitePrefsDocument, sitePrefsDocumentName, sitePrefsMap, sitePrefsMapKey, userPrefs, userPrefsDocument, userPrefsDocumentName
 
Constructor Summary
WcmWorkplaceConfig(com.filenet.wcm.toolkit.server.util.WcmDataStore ds, java.lang.String prefsObjectStoreName, java.lang.String prefName, java.util.Locale locale)
           
 
Method Summary
 java.lang.String createNewSitePrefs()
           
 java.lang.String createNewUserPrefs()
           
 WcmCommonPrefs getCommonPrefs()
           
static DefaultPrefsObjects getDefaultPrefsObjects()
           
static WcmSitePrefs getDefaultSitePreferences()
           
static WcmUserPrefs getDefaultUserPreferences()
           
 WcmEProcessPrefs getEProcessPrefs()
           
 InboxPrefs getInboxPrefs(java.lang.String inboxName)
           
static WcmWorkplaceConfig getInstance(com.filenet.wcm.toolkit.server.base.WcmController controller)
           
 java.lang.String getObjectLabel(java.lang.String objectStoreName, java.lang.String objectID, int objectType)
           
 WcmObjectStorePrefs getObjectStorePrefs(java.lang.String objectStoreName)
           
protected  com.filenet.wcm.api.Permissions getSitePreferencesPermissions()
           
 WcmSitePrefs getSitePrefs()
           
 WcmUserPrefs getUserPrefs()
           
 WebDAVPrefs getWebDAVPrefs()
           
 void loadSitePreferences()
          Overwrites the base class method, adding upgrade behavior
 void loadUserPreferences()
           
 java.lang.String saveSitePreferences()
           
 java.lang.String saveSitePreferences(boolean keepCheckout)
           
 void setWebDAVPrefs(WebDAVPrefs newPrefs)
           
 void updateSitePreferencesSecurity()
           
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.prefs.WcmConfiguration
addNewDocument, addSitePrefsDocument, addUserPrefsDocument, cancelCheckoutSitePreferences, checkinSitePreferences, checkoutSitePreferences, createPreferencesFolder, debugTrace, getBasePath, getBootstrapPrefs, getSitePrefsObject, getUserPrefsObject, initialize, isEProcessConfigured, isSitePreferencesCheckedOut, loadBootstrap, loadBootstrap, loadBootstrap, loadBootstrap, reloadBootstrap, reloadBootstrap, resetSitePreferences, retrieveDocument, retrieveDocument, retrieveDocumentByPath, saveBootstrapPreferences, saveUserPreferences, setBasePath, setSitePrefsObject, setUserPrefsObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

wsNameUndefined

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

LIST_VIEW_MODE_DEFAULT

public static final int LIST_VIEW_MODE_DEFAULT
See Also:
Constant Field Values

LIST_VIEW_MODE_DETAIL

public static final int LIST_VIEW_MODE_DETAIL
See Also:
Constant Field Values

LIST_VIEW_MODE_MAGAZINE

public static final int LIST_VIEW_MODE_MAGAZINE
See Also:
Constant Field Values

TREE_VIEW_MODE_DEFAULT

public static final int TREE_VIEW_MODE_DEFAULT
See Also:
Constant Field Values

TREE_VIEW_MODE_FLAT

public static final int TREE_VIEW_MODE_FLAT
See Also:
Constant Field Values

TREE_VIEW_MODE_TREE

public static final int TREE_VIEW_MODE_TREE
See Also:
Constant Field Values

SEARCH_MODE_DEFAULT

public static final int SEARCH_MODE_DEFAULT
See Also:
Constant Field Values

SEARCH_MODE_SIMPLE

public static final int SEARCH_MODE_SIMPLE
See Also:
Constant Field Values

SEARCH_MODE_TEMPLATE

public static final int SEARCH_MODE_TEMPLATE
See Also:
Constant Field Values

CONFIRM_DEFAULT

public static final int CONFIRM_DEFAULT
See Also:
Constant Field Values

CONFIRM_SHOW

public static final int CONFIRM_SHOW
See Also:
Constant Field Values

CONFIRM_HIDE

public static final int CONFIRM_HIDE
See Also:
Constant Field Values

EXPAND_DEFAULT

public static final int EXPAND_DEFAULT
See Also:
Constant Field Values

EXPAND_YES

public static final int EXPAND_YES
See Also:
Constant Field Values

EXPAND_NO

public static final int EXPAND_NO
See Also:
Constant Field Values

locale

protected java.util.Locale locale
Constructor Detail

WcmWorkplaceConfig

public WcmWorkplaceConfig(com.filenet.wcm.toolkit.server.util.WcmDataStore ds,
                          java.lang.String prefsObjectStoreName,
                          java.lang.String prefName,
                          java.util.Locale locale)
                   throws java.lang.Exception
Method Detail

getInstance

public static WcmWorkplaceConfig getInstance(com.filenet.wcm.toolkit.server.base.WcmController controller)
                                      throws java.lang.Exception
Throws:
java.lang.Exception

getObjectStorePrefs

public WcmObjectStorePrefs getObjectStorePrefs(java.lang.String objectStoreName)

getWebDAVPrefs

public WebDAVPrefs getWebDAVPrefs()

setWebDAVPrefs

public void setWebDAVPrefs(WebDAVPrefs newPrefs)

getInboxPrefs

public InboxPrefs getInboxPrefs(java.lang.String inboxName)
                         throws java.lang.Exception
Throws:
java.lang.Exception

getSitePrefs

public WcmSitePrefs getSitePrefs()

getUserPrefs

public WcmUserPrefs getUserPrefs()

getEProcessPrefs

public WcmEProcessPrefs getEProcessPrefs()
                                  throws java.lang.Exception
Throws:
java.lang.Exception

getCommonPrefs

public WcmCommonPrefs getCommonPrefs()

createNewUserPrefs

public java.lang.String createNewUserPrefs()
                                    throws java.lang.Exception
Throws:
java.lang.Exception

createNewSitePrefs

public java.lang.String createNewSitePrefs()
                                    throws java.lang.Exception
Throws:
java.lang.Exception

loadSitePreferences

public void loadSitePreferences()
                         throws java.lang.Exception
Overwrites the base class method, adding upgrade behavior

Throws:
java.lang.Exception

loadUserPreferences

public void loadUserPreferences()
                         throws java.lang.Exception
Throws:
java.lang.Exception

saveSitePreferences

public java.lang.String saveSitePreferences()
                                     throws java.lang.Exception
Throws:
java.lang.Exception

saveSitePreferences

public java.lang.String saveSitePreferences(boolean keepCheckout)
                                     throws java.lang.Exception
Throws:
java.lang.Exception

getObjectLabel

public java.lang.String getObjectLabel(java.lang.String objectStoreName,
                                       java.lang.String objectID,
                                       int objectType)
                                throws java.lang.Exception
Parameters:
objectStoreName - object store name or id
objectID - object id
objectType - object type
Returns:
String with the object label
Throws:
java.lang.Exception - when errors occur

getDefaultUserPreferences

public static WcmUserPrefs getDefaultUserPreferences()
                                              throws java.lang.Exception
Throws:
java.lang.Exception

getDefaultPrefsObjects

public static DefaultPrefsObjects getDefaultPrefsObjects()
                                                  throws java.lang.Exception
Throws:
java.lang.Exception

getDefaultSitePreferences

public static WcmSitePrefs getDefaultSitePreferences()
                                              throws java.lang.Exception
Throws:
java.lang.Exception

getSitePreferencesPermissions

protected com.filenet.wcm.api.Permissions getSitePreferencesPermissions()
                                                                 throws java.lang.Exception
Throws:
java.lang.Exception

updateSitePreferencesSecurity

public void updateSitePreferencesSecurity()
                                   throws java.lang.Exception
Throws:
java.lang.Exception


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