org.opencms.db
Class CmsUserSettings

java.lang.Object
  extended byorg.opencms.db.CmsUserSettings
Direct Known Subclasses:
CmsDefaultUserSettings

public class CmsUserSettings
extends java.lang.Object

Object to conveniently access and modify the users workplace settings.

Since:
6.0.0
Version:
$Revision: 1.36 $
Author:
Andreas Zahner, Michael Emmerich

Field Summary
static java.lang.String ADDITIONAL_INFO_CITY
          Key for additional info city.
static java.lang.String ADDITIONAL_INFO_CONFIRMED_RESOURCES
          Key for additional info of resources that were confirmemed by the user.
static java.lang.String ADDITIONAL_INFO_COUNTRY
          Key for additional info address.
static java.lang.String ADDITIONAL_INFO_DEFAULTGROUP
          Key for additional info default group.
static java.lang.String ADDITIONAL_INFO_EXPLORERSETTINGS
          Key for additional info explorer settings.
static java.lang.String ADDITIONAL_INFO_PREFERENCES
          Key for additional info flags.
static java.lang.String ADDITIONAL_INFO_STARTSETTINGS
          Key for additional info start settings.
static java.lang.String ADDITIONAL_INFO_TOWN
          Deprecated. use ADDITIONAL_INFO_CITY instead
static java.lang.String ADDITIONAL_INFO_ZIPCODE
          Key for additional info address.
static int FILELIST_DATE_CREATED
          Flag for displaying the date created column.
static int FILELIST_DATE_EXPIRED
          Flag for displaying the date expired column.
static int FILELIST_DATE_LASTMODIFIED
          Flag for displaying the changed column.
static int FILELIST_DATE_RELEASED
          Flag for displaying the date released column.
static int FILELIST_LOCKEDBY
          Flag for displaying the locked column.
static int FILELIST_NAME
          Flag for displaying the name column.
static int FILELIST_PERMISSIONS
          Flag for displaying the access column.
static int FILELIST_SIZE
          Flag for displaying the size column.
static int FILELIST_STATE
          Flag for displaying the state column.
static int FILELIST_TITLE
          Flag for displaying the title column.
static int FILELIST_TYPE
          Flag for displaying the filetype column.
static int FILELIST_USER_CREATED
          Flag for displaying the owner column.
static int FILELIST_USER_LASTMODIFIED
          Flag for displaying the user who last modified column.
 
Constructor Summary
CmsUserSettings()
          Creates an empty new user settings object.
CmsUserSettings(CmsObject cms)
          Creates a user settings object with initialized settings of the current user.
CmsUserSettings(CmsObject cms, CmsUser user)
          Creates a user settings object with initialized settings of the user.
CmsUserSettings(CmsUser user)
          Creates a user settings object with initialized settings of the user.
 
Method Summary
 int getDialogCopyFileMode()
          Gets the default copy mode when copying a file of the user.
 int getDialogCopyFolderMode()
          Gets the default copy mode when copying a folder of the user.
 int getDialogDeleteFileMode()
          Returns the default setting for file deletion.
 boolean getDialogExpandInheritedPermissions()
          Returns the default setting for expanding inherited permissions in the dialog.
 boolean getDialogExpandUserPermissions()
          Returns the default setting for expanding the users permissions in the dialog.
 boolean getDialogPermissionsInheritOnFolder()
          Returns the default setting for inheriting permissions on folders.
 boolean getDialogPublishSiblings()
          Returns the default setting for direct publishing.
 boolean getDialogShowExportSettings()
          Determines if the export part of the secure/export dialog should be shown.
 boolean getDialogShowLock()
          Determines if the lock dialog should be shown.
 int getDirectEditButtonStyle()
          Returns the style of the direct edit buttons of the user.
 int getEditorButtonStyle()
          Returns the style of the editor buttons of the user.
 java.util.Map getEditorSettings()
          Returns the editor settings of the user.
 int getExplorerButtonStyle()
          Returns the style of the explorer buttons of the user.
 int getExplorerFileEntries()
          Returns the number of displayed files per page of the user.
 int getExplorerSettings()
          Returns the explorer start settings.
 java.util.Locale getLocale()
          Returns the locale of the user.
 java.lang.String getPreferredEditor(java.lang.String resourceType)
          Returns the preferred editor for the given resource type of the user.
 CmsUserProjectSettings getProjectSettings()
          Returns the project Settings.
 java.lang.String getPublishButtonAppearance()
          Returns the appearance of the "publish project" button.
 boolean getRestrictExplorerView()
          Sets if the explorer view is restricted to the defined site and folder.
 java.lang.String getStartFolder()
          Returns the start folder of the user.
 java.lang.String getStartProject()
          Returns the start project of the user.
 java.lang.String getStartSite()
          Returns the start site of the user.
 java.lang.String getStartView()
          Returns the current start view of the user.
 CmsSynchronizeSettings getSynchronizeSettings()
          Returns the (optional) workplace synchronize settings.
 boolean getTaskMessageAccepted()
          Determines if a message should be sent if the task is accepted.
 boolean getTaskMessageCompleted()
          Determines if a message should be sent if the task is completed.
 boolean getTaskMessageForwarded()
          Determines if a message should be sent if the task is forwarded.
 boolean getTaskMessageMembers()
          Determines if all role members should be informed about the task.
 int getTaskMessageValue()
          Returns the task messages value for the tasks view.
 boolean getTaskShowAllProjects()
          Determines if all projects should be shown in tasks view.
 java.lang.String getTaskStartupFilter()
          Returns the startup filter for the tasks view.
 CmsUser getUser()
          Returns the current user for the settings.
 int getWorkplaceButtonStyle()
          Returns the style of the workplace buttons of the user.
 java.lang.String getWorkplaceReportType()
          Returns the type of the report (simple or extended) of the user.
 void init(CmsObject cms, CmsUser user)
          Initializes the user settings with the given users setting parameters.
 void init(CmsUser user)
          Initializes the user settings with the given users setting parameters.
 void save(CmsObject cms)
          Saves the changed settings of the user to the user object.
 void setDialogCopyFileMode(int mode)
          Sets the default copy mode when copying a file of the user.
 void setDialogCopyFolderMode(int mode)
          Sets the default copy mode when copying a folder of the user.
 void setDialogDeleteFileMode(int mode)
          Sets the default setting for file deletion.
 void setDialogExpandInheritedPermissions(boolean dialogShowInheritedPermissions)
          Sets the default setting for expanding inherited permissions in the dialog.
 void setDialogExpandUserPermissions(boolean dialogShowUserPermissions)
          Sets the default setting for expanding the users permissions in the dialog.
 void setDialogPermissionsInheritOnFolder(boolean dialogPermissionsInheritOnFolder)
          Sets the default setting for inheriting permissions on folders.
 void setDialogPublishSiblings(boolean publishSiblings)
          Sets the default setting for direct publishing.
 void setDialogShowExportSettings(boolean show)
          Sets if the export setting part of the secure/export dialog should be shown.
 void setDialogShowLock(boolean show)
          Sets if the lock dialog should be shown.
 void setDirectEditButtonStyle(int style)
          Sets the style of the direct edit buttons of the user.
 void setEditorButtonStyle(int style)
          Sets the style of the editor buttons of the user.
 void setEditorSettings(java.util.Map settings)
          Sets the editor settings of the user.
 void setExplorerButtonStyle(int style)
          Sets the style of the explorer buttons of the user.
 void setExplorerFileEntries(int entries)
          Sets the number of displayed files per page of the user.
 void setExplorerSettings(int settings)
          Sets the explorer start settings.
 void setLocale(java.util.Locale locale)
          Sets the locale of the user.
 void setPreferredEditor(java.lang.String resourceType, java.lang.String editorUri)
          Sets the preferred editor for the given resource type of the user.
 void setProjectSettings(CmsUserProjectSettings projectSettings)
          Sets the project Settings.
 void setPublishButtonAppearance(java.lang.String publishButtonAppearance)
          Sets the appearance of the "publish project" button.
 void setRestrictExplorerView(boolean restrict)
          Sets if the explorer view is restricted to the defined site and folder.
 void setShowExplorerFileDateCreated(boolean show)
          Sets if the file creation date should be shown in explorer view.
 void setShowExplorerFileDateExpired(boolean show)
          Sets if the file expire date should be shown in explorer view.
 void setShowExplorerFileDateLastModified(boolean show)
          Sets if the file last modified date should be shown in explorer view.
 void setShowExplorerFileDateReleased(boolean show)
          Sets if the file release date should be shown in explorer view.
 void setShowExplorerFileLockedBy(boolean show)
          Sets if the file locked by should be shown in explorer view.
 void setShowExplorerFilePermissions(boolean show)
          Sets if the file permissions should be shown in explorer view.
 void setShowExplorerFileSize(boolean show)
          Sets if the file size should be shown in explorer view.
 void setShowExplorerFileState(boolean show)
          Sets if the file state should be shown in explorer view.
 void setShowExplorerFileTitle(boolean show)
          Sets if the file title should be shown in explorer view.
 void setShowExplorerFileType(boolean show)
          Sets if the file type should be shown in explorer view.
 void setShowExplorerFileUserCreated(boolean show)
          Sets if the file creator should be shown in explorer view.
 void setShowExplorerFileUserLastModified(boolean show)
          Sets if the file last modified by should be shown in explorer view.
 void setStartFolder(java.lang.String folder)
          Sets the start folder of the user.
 void setStartProject(java.lang.String project)
          Sets the start project of the user.
 void setStartSite(java.lang.String site)
          Sets the start site of the user.
 void setStartView(java.lang.String view)
          Sets the current start view of the user.
 void setSynchronizeSettings(CmsSynchronizeSettings synchronizeSettings)
          Sets the (optional) workplace synchronize settings.
 void setTaskMessageAccepted(boolean message)
          Sets if a message should be sent if the task is accepted.
 void setTaskMessageCompleted(boolean message)
          Sets if a message should be sent if the task is completed.
 void setTaskMessageForwarded(boolean message)
          Sets if a message should be sent if the task is forwarded.
 void setTaskMessageMembers(boolean message)
          Sets if all role members should be informed about the task.
 void setTaskMessageValue(int value)
          Sets the task message values.
 void setTaskShowAllProjects(boolean show)
          Sets if all projects should be shown in tasks view.
 void setTaskStartupFilter(java.lang.String filter)
          Sets the startup filter for the tasks view.
 void setUser(CmsUser user)
          Sets the current user for the settings.
 void setUseUploadApplet(boolean use)
          Sets if the upload applet should be used.
 void setWorkplaceButtonStyle(int style)
          Sets the style of the workplace buttons of the user.
 void setWorkplaceReportType(java.lang.String type)
          Sets the type of the report (simple or extended) of the user.
 boolean showExplorerFileDateCreated()
          Determines if the file creation date should be shown in explorer view.
 boolean showExplorerFileDateExpired()
          Determines if the file date expired should be shown in explorer view.
 boolean showExplorerFileDateLastModified()
          Determines if the file last modified date should be shown in explorer view.
 boolean showExplorerFileDateReleased()
          Determines if the file date released should be shown in explorer view.
 boolean showExplorerFileLockedBy()
          Determines if the file locked by should be shown in explorer view.
 boolean showExplorerFilePermissions()
          Determines if the file permissions should be shown in explorer view.
 boolean showExplorerFileSize()
          Determines if the file size should be shown in explorer view.
 boolean showExplorerFileState()
          Determines if the file state should be shown in explorer view.
 boolean showExplorerFileTitle()
          Determines if the file title should be shown in explorer view.
 boolean showExplorerFileType()
          Determines if the file type should be shown in explorer view.
 boolean showExplorerFileUserCreated()
          Determines if the file creator should be shown in explorer view.
 boolean showExplorerFileUserLastModified()
          Determines if the file last modified by should be shown in explorer view.
 boolean useUploadApplet()
          Determines if the upload applet should be used.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ADDITIONAL_INFO_CONFIRMED_RESOURCES

public static final java.lang.String ADDITIONAL_INFO_CONFIRMED_RESOURCES
Key for additional info of resources that were confirmemed by the user.

See Also:
Constant Field Values

ADDITIONAL_INFO_COUNTRY

public static final java.lang.String ADDITIONAL_INFO_COUNTRY
Key for additional info address.

See Also:
Constant Field Values

ADDITIONAL_INFO_DEFAULTGROUP

public static final java.lang.String ADDITIONAL_INFO_DEFAULTGROUP
Key for additional info default group.

See Also:
Constant Field Values

ADDITIONAL_INFO_EXPLORERSETTINGS

public static final java.lang.String ADDITIONAL_INFO_EXPLORERSETTINGS
Key for additional info explorer settings.

See Also:
Constant Field Values

ADDITIONAL_INFO_PREFERENCES

public static final java.lang.String ADDITIONAL_INFO_PREFERENCES
Key for additional info flags.

See Also:
Constant Field Values

ADDITIONAL_INFO_STARTSETTINGS

public static final java.lang.String ADDITIONAL_INFO_STARTSETTINGS
Key for additional info start settings.

See Also:
Constant Field Values

ADDITIONAL_INFO_CITY

public static final java.lang.String ADDITIONAL_INFO_CITY
Key for additional info city.

See Also:
Constant Field Values

ADDITIONAL_INFO_TOWN

public static final java.lang.String ADDITIONAL_INFO_TOWN
Deprecated. use ADDITIONAL_INFO_CITY instead

Key for additional info city.

See Also:
Constant Field Values

ADDITIONAL_INFO_ZIPCODE

public static final java.lang.String ADDITIONAL_INFO_ZIPCODE
Key for additional info address.

See Also:
Constant Field Values

FILELIST_DATE_CREATED

public static final int FILELIST_DATE_CREATED
Flag for displaying the date created column.

See Also:
Constant Field Values

FILELIST_DATE_EXPIRED

public static final int FILELIST_DATE_EXPIRED
Flag for displaying the date expired column.

See Also:
Constant Field Values

FILELIST_DATE_LASTMODIFIED

public static final int FILELIST_DATE_LASTMODIFIED
Flag for displaying the changed column.

See Also:
Constant Field Values

FILELIST_DATE_RELEASED

public static final int FILELIST_DATE_RELEASED
Flag for displaying the date released column.

See Also:
Constant Field Values

FILELIST_LOCKEDBY

public static final int FILELIST_LOCKEDBY
Flag for displaying the locked column.

See Also:
Constant Field Values

FILELIST_NAME

public static final int FILELIST_NAME
Flag for displaying the name column.

See Also:
Constant Field Values

FILELIST_PERMISSIONS

public static final int FILELIST_PERMISSIONS
Flag for displaying the access column.

See Also:
Constant Field Values

FILELIST_SIZE

public static final int FILELIST_SIZE
Flag for displaying the size column.

See Also:
Constant Field Values

FILELIST_STATE

public static final int FILELIST_STATE
Flag for displaying the state column.

See Also:
Constant Field Values

FILELIST_TITLE

public static final int FILELIST_TITLE
Flag for displaying the title column.

See Also:
Constant Field Values

FILELIST_TYPE

public static final int FILELIST_TYPE
Flag for displaying the filetype column.

See Also:
Constant Field Values

FILELIST_USER_CREATED

public static final int FILELIST_USER_CREATED
Flag for displaying the owner column.

See Also:
Constant Field Values

FILELIST_USER_LASTMODIFIED

public static final int FILELIST_USER_LASTMODIFIED
Flag for displaying the user who last modified column.

See Also:
Constant Field Values
Constructor Detail

CmsUserSettings

public CmsUserSettings()
Creates an empty new user settings object.


CmsUserSettings

public CmsUserSettings(CmsObject cms)
Creates a user settings object with initialized settings of the current user.

Parameters:
cms - the OpenCms context

CmsUserSettings

public CmsUserSettings(CmsObject cms,
                       CmsUser user)
Creates a user settings object with initialized settings of the user.

Parameters:
cms - the OpenCms context
user - the OpenCms user

CmsUserSettings

public CmsUserSettings(CmsUser user)
Creates a user settings object with initialized settings of the user.

Some default settings will be unset, if no cms object is given.

Parameters:
user - the current CmsUser
See Also:
CmsUserSettings(CmsObject, CmsUser)
Method Detail

getDialogCopyFileMode

public int getDialogCopyFileMode()
Gets the default copy mode when copying a file of the user.

Returns:
the default copy mode when copying a file of the user

getDialogCopyFolderMode

public int getDialogCopyFolderMode()
Gets the default copy mode when copying a folder of the user.

Returns:
the default copy mode when copying a folder of the user

getDialogDeleteFileMode

public int getDialogDeleteFileMode()
Returns the default setting for file deletion.

Returns:
the default setting for file deletion

getDialogExpandInheritedPermissions

public boolean getDialogExpandInheritedPermissions()
Returns the default setting for expanding inherited permissions in the dialog.

Returns:
true if inherited permissions should be expanded, otherwise false

getDialogExpandUserPermissions

public boolean getDialogExpandUserPermissions()
Returns the default setting for expanding the users permissions in the dialog.

Returns:
true if the users permissions should be expanded, otherwise false

getDialogPermissionsInheritOnFolder

public boolean getDialogPermissionsInheritOnFolder()
Returns the default setting for inheriting permissions on folders.

Returns:
true if permissions should be inherited on folders, otherwise false

getDialogPublishSiblings

public boolean getDialogPublishSiblings()
Returns the default setting for direct publishing.

Returns:
the default setting for direct publishing: true if siblings should be published, otherwise false

getDialogShowExportSettings

public boolean getDialogShowExportSettings()
Determines if the export part of the secure/export dialog should be shown.

Returns:
true if the export dialog is shown, otherwise false

getDialogShowLock

public boolean getDialogShowLock()
Determines if the lock dialog should be shown.

Returns:
true if the lock dialog is shown, otherwise false

getDirectEditButtonStyle

public int getDirectEditButtonStyle()
Returns the style of the direct edit buttons of the user.

Returns:
the style of the direct edit buttons of the user

getEditorButtonStyle

public int getEditorButtonStyle()
Returns the style of the editor buttons of the user.

Returns:
the style of the editor buttons of the user

getEditorSettings

public java.util.Map getEditorSettings()
Returns the editor settings of the user.

Returns:
the editor settings of the user

getExplorerButtonStyle

public int getExplorerButtonStyle()
Returns the style of the explorer buttons of the user.

Returns:
the style of the explorer buttons of the user

getExplorerFileEntries

public int getExplorerFileEntries()
Returns the number of displayed files per page of the user.

Returns:
the number of displayed files per page of the user

getExplorerSettings

public int getExplorerSettings()
Returns the explorer start settings.

Returns:
the explorer start settings

getLocale

public java.util.Locale getLocale()
Returns the locale of the user.

Returns:
the loclae of the user

getPreferredEditor

public java.lang.String getPreferredEditor(java.lang.String resourceType)
Returns the preferred editor for the given resource type of the user.

Parameters:
resourceType - the resource type
Returns:
the preferred editor for the resource type or null, if not specified

getProjectSettings

public CmsUserProjectSettings getProjectSettings()
Returns the project Settings.

Returns:
the project Settings

getPublishButtonAppearance

public java.lang.String getPublishButtonAppearance()
Returns the appearance of the "publish project" button.

Returns:
the appearance of the "publish project" button

getRestrictExplorerView

public boolean getRestrictExplorerView()
Sets if the explorer view is restricted to the defined site and folder.

Returns:
true if the explorer view is restricted, otherwise false

getStartFolder

public java.lang.String getStartFolder()
Returns the start folder of the user.

Returns:
the start folder of the user

getStartProject

public java.lang.String getStartProject()
Returns the start project of the user.

Returns:
the start project of the user

getStartSite

public java.lang.String getStartSite()
Returns the start site of the user.

Returns:
the start site of the user

getStartView

public java.lang.String getStartView()
Returns the current start view of the user.

Returns:
the current start view of the user

getSynchronizeSettings

public CmsSynchronizeSettings getSynchronizeSettings()
Returns the (optional) workplace synchronize settings.

Returns:
the (optional) workplace synchronize settings

getTaskMessageAccepted

public boolean getTaskMessageAccepted()
Determines if a message should be sent if the task is accepted.

Returns:
true if a message should be sent if the task is accepted, otherwise false

getTaskMessageCompleted

public boolean getTaskMessageCompleted()
Determines if a message should be sent if the task is completed.

Returns:
true if a message should be sent if the task is completed, otherwise false

getTaskMessageForwarded

public boolean getTaskMessageForwarded()
Determines if a message should be sent if the task is forwarded.

Returns:
true if a message should be sent if the task is forwarded, otherwise false

getTaskMessageMembers

public boolean getTaskMessageMembers()
Determines if all role members should be informed about the task.

Returns:
true if all role members should be informed about the task, otherwise false

getTaskMessageValue

public int getTaskMessageValue()
Returns the task messages value for the tasks view.

Returns:
task messages value for the tasks view

getTaskShowAllProjects

public boolean getTaskShowAllProjects()
Determines if all projects should be shown in tasks view.

Returns:
true if all projects should be shown in tasks view, otherwise false

getTaskStartupFilter

public java.lang.String getTaskStartupFilter()
Returns the startup filter for the tasks view.

Returns:
the startup filter for the tasks view

getUser

public CmsUser getUser()
Returns the current user for the settings.

Returns:
the CmsUser

getWorkplaceButtonStyle

public int getWorkplaceButtonStyle()
Returns the style of the workplace buttons of the user.

Returns:
the style of the workplace buttons of the user

getWorkplaceReportType

public java.lang.String getWorkplaceReportType()
Returns the type of the report (simple or extended) of the user.

Returns:
the type of the report (simple or extended) of the user

init

public void init(CmsObject cms,
                 CmsUser user)
Initializes the user settings with the given users setting parameters.

Parameters:
cms - the OpenCms context
user - the current CmsUser

init

public void init(CmsUser user)
Initializes the user settings with the given users setting parameters.

Some default settings will be unset, if no cms object is given.

Parameters:
user - the current CmsUser
See Also:
init(CmsObject, CmsUser)

save

public void save(CmsObject cms)
          throws CmsException
Saves the changed settings of the user to the user object.

If the given CmsObject is null, the additional user infos are only updated in memory and not saved into the database.

Parameters:
cms - the CmsObject needed to write the user to the db
Throws:
CmsException - if user cannot be written to the db

setDialogCopyFileMode

public void setDialogCopyFileMode(int mode)
Sets the default copy mode when copying a file of the user.

Parameters:
mode - the default copy mode when copying a file of the user

setDialogCopyFolderMode

public void setDialogCopyFolderMode(int mode)
Sets the default copy mode when copying a folder of the user.

Parameters:
mode - the default copy mode when copying a folder of the user

setDialogDeleteFileMode

public void setDialogDeleteFileMode(int mode)
Sets the default setting for file deletion.

Parameters:
mode - the default setting for file deletion

setDialogExpandInheritedPermissions

public void setDialogExpandInheritedPermissions(boolean dialogShowInheritedPermissions)
Sets the default setting for expanding inherited permissions in the dialog.

Parameters:
dialogShowInheritedPermissions - the default setting for expanding inherited permissions in the dialog

setDialogExpandUserPermissions

public void setDialogExpandUserPermissions(boolean dialogShowUserPermissions)
Sets the default setting for expanding the users permissions in the dialog.

Parameters:
dialogShowUserPermissions - the default setting for expanding the users permissions in the dialog

setDialogPermissionsInheritOnFolder

public void setDialogPermissionsInheritOnFolder(boolean dialogPermissionsInheritOnFolder)
Sets the default setting for inheriting permissions on folders.

Parameters:
dialogPermissionsInheritOnFolder - the default setting for inheriting permissions on folders

setDialogPublishSiblings

public void setDialogPublishSiblings(boolean publishSiblings)
Sets the default setting for direct publishing.

Parameters:
publishSiblings - the default setting for direct publishing: true if siblings should be published, otherwise false

setDialogShowExportSettings

public void setDialogShowExportSettings(boolean show)
Sets if the export setting part of the secure/export dialog should be shown.

Parameters:
show - true if the export dialog should be shown, otherwise false

setDialogShowLock

public void setDialogShowLock(boolean show)
Sets if the lock dialog should be shown.

Parameters:
show - true if the lock dialog should be shown, otherwise false

setDirectEditButtonStyle

public void setDirectEditButtonStyle(int style)
Sets the style of the direct edit buttons of the user.

Parameters:
style - the style of the direct edit buttons of the user

setEditorButtonStyle

public void setEditorButtonStyle(int style)
Sets the style of the editor buttons of the user.

Parameters:
style - the style of the editor buttons of the user

setEditorSettings

public void setEditorSettings(java.util.Map settings)
Sets the editor settings of the user.

Parameters:
settings - the editor settings of the user

setExplorerButtonStyle

public void setExplorerButtonStyle(int style)
Sets the style of the explorer buttons of the user.

Parameters:
style - the style of the explorer buttons of the user

setExplorerFileEntries

public void setExplorerFileEntries(int entries)
Sets the number of displayed files per page of the user.

Parameters:
entries - the number of displayed files per page of the user

setExplorerSettings

public void setExplorerSettings(int settings)
Sets the explorer start settings.

Parameters:
settings - explorer start settings tu use

setLocale

public void setLocale(java.util.Locale locale)
Sets the locale of the user.

Parameters:
locale - the locale of the user

setPreferredEditor

public void setPreferredEditor(java.lang.String resourceType,
                               java.lang.String editorUri)
Sets the preferred editor for the given resource type of the user.

Parameters:
resourceType - the resource type
editorUri - the editor URI

setProjectSettings

public void setProjectSettings(CmsUserProjectSettings projectSettings)
Sets the project Settings.

Parameters:
projectSettings - the project Settings to set

setPublishButtonAppearance

public void setPublishButtonAppearance(java.lang.String publishButtonAppearance)
Sets the appearance of the "publish project" button.

Parameters:
publishButtonAppearance - the appearance of the "publish project" button

setRestrictExplorerView

public void setRestrictExplorerView(boolean restrict)
Sets if the explorer view is restricted to the defined site and folder.

Parameters:
restrict - true if the explorer view is restricted, otherwise false

setShowExplorerFileDateCreated

public void setShowExplorerFileDateCreated(boolean show)
Sets if the file creation date should be shown in explorer view.

Parameters:
show - true if the file creation date should be shown, otherwise false

setShowExplorerFileDateExpired

public void setShowExplorerFileDateExpired(boolean show)
Sets if the file expire date should be shown in explorer view.

Parameters:
show - true if the file expire date should be shown, otherwise false

setShowExplorerFileDateLastModified

public void setShowExplorerFileDateLastModified(boolean show)
Sets if the file last modified date should be shown in explorer view.

Parameters:
show - true if the file last modified date should be shown, otherwise false

setShowExplorerFileDateReleased

public void setShowExplorerFileDateReleased(boolean show)
Sets if the file release date should be shown in explorer view.

Parameters:
show - true if the file release date should be shown, otherwise false

setShowExplorerFileLockedBy

public void setShowExplorerFileLockedBy(boolean show)
Sets if the file locked by should be shown in explorer view.

Parameters:
show - true if the file locked by should be shown, otherwise false

setShowExplorerFilePermissions

public void setShowExplorerFilePermissions(boolean show)
Sets if the file permissions should be shown in explorer view.

Parameters:
show - true if the file permissions should be shown, otherwise false

setShowExplorerFileSize

public void setShowExplorerFileSize(boolean show)
Sets if the file size should be shown in explorer view.

Parameters:
show - true if the file size should be shown, otherwise false

setShowExplorerFileState

public void setShowExplorerFileState(boolean show)
Sets if the file state should be shown in explorer view.

Parameters:
show - true if the state size should be shown, otherwise false

setShowExplorerFileTitle

public void setShowExplorerFileTitle(boolean show)
Sets if the file title should be shown in explorer view.

Parameters:
show - true if the file title should be shown, otherwise false

setShowExplorerFileType

public void setShowExplorerFileType(boolean show)
Sets if the file type should be shown in explorer view.

Parameters:
show - true if the file type should be shown, otherwise false

setShowExplorerFileUserCreated

public void setShowExplorerFileUserCreated(boolean show)
Sets if the file creator should be shown in explorer view.

Parameters:
show - true if the file creator should be shown, otherwise false

setShowExplorerFileUserLastModified

public void setShowExplorerFileUserLastModified(boolean show)
Sets if the file last modified by should be shown in explorer view.

Parameters:
show - true if the file last modified by should be shown, otherwise false

setStartFolder

public void setStartFolder(java.lang.String folder)
Sets the start folder of the user.

Parameters:
folder - the start folder of the user

setStartProject

public void setStartProject(java.lang.String project)
Sets the start project of the user.

Parameters:
project - the start project id of the user

setStartSite

public void setStartSite(java.lang.String site)
Sets the start site of the user.

Parameters:
site - the start site of the user

setStartView

public void setStartView(java.lang.String view)
Sets the current start view of the user.

Parameters:
view - the current start view of the user

setSynchronizeSettings

public void setSynchronizeSettings(CmsSynchronizeSettings synchronizeSettings)
Sets the (optional) workplace synchronize settings.

Parameters:
synchronizeSettings - the (optional) workplace synchronize settings to set

setTaskMessageAccepted

public void setTaskMessageAccepted(boolean message)
Sets if a message should be sent if the task is accepted.

Parameters:
message - true if a message should be sent if the task is accepted, otherwise false

setTaskMessageCompleted

public void setTaskMessageCompleted(boolean message)
Sets if a message should be sent if the task is completed.

Parameters:
message - true if a message should be sent if the task is completed, otherwise false

setTaskMessageForwarded

public void setTaskMessageForwarded(boolean message)
Sets if a message should be sent if the task is forwarded.

Parameters:
message - true if a message should be sent if the task is forwarded, otherwise false

setTaskMessageMembers

public void setTaskMessageMembers(boolean message)
Sets if all role members should be informed about the task.

Parameters:
message - true if all role members should be informed about the task, otherwise false

setTaskMessageValue

public void setTaskMessageValue(int value)
Sets the task message values.

Parameters:
value - the value of the task messages

setTaskShowAllProjects

public void setTaskShowAllProjects(boolean show)
Sets if all projects should be shown in tasks view.

Parameters:
show - true if all projects should be shown in tasks view, otherwise false

setTaskStartupFilter

public void setTaskStartupFilter(java.lang.String filter)
Sets the startup filter for the tasks view.

Parameters:
filter - the startup filter for the tasks view

setUser

public void setUser(CmsUser user)
Sets the current user for the settings.

Parameters:
user - the CmsUser

setUseUploadApplet

public void setUseUploadApplet(boolean use)
Sets if the upload applet should be used.

Parameters:
use - true if the upload applet should be used, otherwise false

setWorkplaceButtonStyle

public void setWorkplaceButtonStyle(int style)
Sets the style of the workplace buttons of the user.

Parameters:
style - the style of the workplace buttons of the user

setWorkplaceReportType

public void setWorkplaceReportType(java.lang.String type)
Sets the type of the report (simple or extended) of the user.

Parameters:
type - the type of the report (simple or extended) of the user

showExplorerFileDateCreated

public boolean showExplorerFileDateCreated()
Determines if the file creation date should be shown in explorer view.

Returns:
true if the file creation date should be shown, otherwise false

showExplorerFileDateExpired

public boolean showExplorerFileDateExpired()
Determines if the file date expired should be shown in explorer view.

Returns:
true if the file date expired should be shown, otherwise false

showExplorerFileDateLastModified

public boolean showExplorerFileDateLastModified()
Determines if the file last modified date should be shown in explorer view.

Returns:
true if the file last modified date should be shown, otherwise false

showExplorerFileDateReleased

public boolean showExplorerFileDateReleased()
Determines if the file date released should be shown in explorer view.

Returns:
true if the file date released should be shown, otherwise false

showExplorerFileLockedBy

public boolean showExplorerFileLockedBy()
Determines if the file locked by should be shown in explorer view.

Returns:
true if the file locked by should be shown, otherwise false

showExplorerFilePermissions

public boolean showExplorerFilePermissions()
Determines if the file permissions should be shown in explorer view.

Returns:
true if the file permissions should be shown, otherwise false

showExplorerFileSize

public boolean showExplorerFileSize()
Determines if the file size should be shown in explorer view.

Returns:
true if the file size should be shown, otherwise false

showExplorerFileState

public boolean showExplorerFileState()
Determines if the file state should be shown in explorer view.

Returns:
true if the file state should be shown, otherwise false

showExplorerFileTitle

public boolean showExplorerFileTitle()
Determines if the file title should be shown in explorer view.

Returns:
true if the file title should be shown, otherwise false

showExplorerFileType

public boolean showExplorerFileType()
Determines if the file type should be shown in explorer view.

Returns:
true if the file type should be shown, otherwise false

showExplorerFileUserCreated

public boolean showExplorerFileUserCreated()
Determines if the file creator should be shown in explorer view.

Returns:
true if the file creator should be shown, otherwise false

showExplorerFileUserLastModified

public boolean showExplorerFileUserLastModified()
Determines if the file last modified by should be shown in explorer view.

Returns:
true if the file last modified by should be shown, otherwise false

useUploadApplet

public boolean useUploadApplet()
Determines if the upload applet should be used.

Returns:
true if the if the upload applet should be used, otherwise false