DesktopConfig

java.lang.Object
- com.ibm.ecm.configuration.ConfigurationObject
- - com.ibm.ecm.configuration.DesktopConfig

All Implemented Interfaces:

ConfigurationValidation, java.io.Serializable

Direct Known Subclasses:

DraftDesktopConfig
```
public class DesktopConfig
extends ConfigurationObject
implements java.io.Serializable, ConfigurationValidation
```
See Also:

Serialized Form

Field Summary
- Fields inherited from class com.ibm.ecm.configuration.ConfigurationObject
  ARRAY_DELIMITER, cloned, configuration, DEFAULT_PROPERTY_VALUE_MAP, ERROR_MISSING_KEY, fromTenant, KEY_DELIMITER, LIST_ESC_CHAR, LIST_SEPARATOR, MODIFIER, PLACEHOLDER_SECRET, properties, returnCopyFromCache

Constructor Summary

Constructors
Constructor and Description
`DesktopConfig(org.apache.commons.configuration.Configuration configuration, java.lang.String idPrefix, java.lang.String id)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`delete()` Deletes the related mobile application feature, interface text, and interface text locale object from the configuration store.
`void`	`exportDesktopFeatures(java.lang.String appName, java.io.OutputStreamWriter osw)`
`void`	`exportInterfaceText(java.lang.String appName, java.io.OutputStreamWriter osw)`
`void`	`exportMobileFeature(java.lang.String appName, java.io.OutputStreamWriter osw)`
`void`	`exportSecurity(java.lang.String appName, java.io.OutputStreamWriter osw)`
`java.lang.String`	`getActionHandler()`
`boolean`	`getAddDocFoldersToRepo()`
`boolean`	`getAddDocUsingExistingSearch()`
`boolean`	`getAddPhotoFromMobile()`
`boolean`	`getAddWithEntryTemplateOnly()`
`java.lang.String`	`getAdminRoleId()` Since 3.0.3
`boolean`	`getAllowChangeETDuringCheckin()`
`boolean`	`getAllowCollaborativeEditing()`
`boolean`	`getAllowEmailAttachments()`
`java.lang.String`	`getApplicationName()`
`java.lang.String[]`	`getApplicationNameLabels()`
`java.util.Collection<InterfaceTextConfig>`	`getApplicationNameLabelsList(java.lang.String idPrefix)`
`java.util.Collection<InterfaceTextLocaleConfig>`	`getApplicationNameLabelsLocaleList(java.lang.String idPrefix)`
`java.lang.String[]`	`getApplicationSpaceLabels()`
`java.util.Collection<InterfaceTextConfig>`	`getApplicationSpaceLabelsList(java.lang.String idPrefix)`
`java.util.Collection<InterfaceTextLocaleConfig>`	`getApplicationSpaceLabelsLocaleList(java.lang.String idPrefix)`
`boolean`	`getAsperaEnabled()`
`boolean`	`getAsperaShowLink()`
`java.lang.String[]`	`getAssignedMobileFeaturesId()`
`boolean`	`getAuditHistoryEnabledOnDesktop()`
`com.ibm.ecm.Constants.AuthenticationType`	`getAuthenticationType()`
`boolean`	`getAutoCCSender()`
`java.lang.String`	`getBannerApplicationNameColor()`
`java.lang.String`	`getBannerBackgroundColor()`
`java.lang.String`	`getBannerLogoUrl()`
`java.lang.String`	`getBannerMenuColor()`
`boolean`	`getBookmarkShowFeatureListEnabled()`
`boolean`	`getCheckoutDocumentAfterAdd()`
`boolean`	`getCheckoutOnOpenDoc()`
`boolean`	`getCloseTaskPaneOnOpen()`
`boolean`	`getContentElementNavigation()`
`int`	`getControlThreshold()`
`boolean`	`getCulturalCollation()`
`protected java.lang.Class`	`getDataType(java.lang.String key)` Returns the datatype of a configuration property.
`java.lang.String`	`getDefault()`
`java.lang.String`	`getDefaultFeature()`
`java.lang.String`	`getDefaultRepositoryId()`
`boolean`	`getDeleteEmailOnAdd()`
`boolean`	`getDeleteLocalOnAdd()`
`boolean`	`getDeleteLocalOnCheckin()`
`boolean`	`getDeleteLocalOnSave()`
`boolean`	`getDeleteOpenDocsAfterClose()`
`java.lang.String`	`getDescription()`
`java.util.Collection<DesktopFeatureConfig>`	`getDesktopFeatureList(java.lang.String idPrefix)`
`java.lang.String[]`	`getDesktopFeaturesIds()`
`protected java.lang.String`	`getDesktopId()`
`java.lang.String`	`getDesktopType()`
`java.lang.String`	`getDesktopVirtualCustomSettings()`
`boolean`	`getDisableAutocomplete()`
`boolean`	`getDisableDocumentTypeFiltering()`
`java.lang.String`	`getDocumentAddMode()`
`int`	`getEditGroupAddButtonSetting()`
`java.lang.String`	`getEmailClientApp()`
`boolean`	`getEmailClientEnabled()`
`boolean`	`getEmailLookAhead()`
`boolean`	`getEmailServiceEnabled()`
`boolean`	`getEnableAllPlugins()`
`boolean`	`getEnableHideTimePortion()`
`boolean`	`getEnablePropMappingForAdd()`
`java.lang.String`	`getEntryTemplatesDefaultRepository()`
`java.util.Collection<InterfaceTextConfig>`	`getFeatureLabelsList(java.lang.String idPrefix)`
`java.lang.String[]`	`getFeatures()`
`boolean`	`getFileIntoFolder()`
`boolean`	`getFromEmailModifiable()`
`java.lang.String`	`getHelpUrl()`
`boolean`	`getHideEntryTemplateNotFoundWarning()`
`boolean`	`getHideSaveDocument()`
`boolean`	`getHideSearchActions()`
`boolean`	`getIndicateManagedEmailOnAdd()`
`java.lang.String`	`getKCHelpContext()`
`java.lang.String`	`getKCHelpTaxonomy()`
`java.lang.String`	`getKCHelpWelcomeFile()`
`java.lang.String`	`getLayout()`
`java.lang.String`	`getLayoutLogFile()`
`java.util.Collection`	`getList(java.lang.String type, java.lang.String appName, javax.servlet.http.HttpServletRequest request)` Abstract method that needs to be override in concrete class to a return a collection back by type.
`static java.lang.String`	`getLocalizedAppSpaceLabel(java.util.Collection<InterfaceTextConfig> list, java.lang.String repositoryId, java.lang.String appSpace, java.util.Locale locale)`
`static java.lang.String`	`getLocalizedFeatureLabel(MobileFeatureConfig mobileConfig, java.util.Locale locale)`
`java.lang.String`	`getLoginInformationUrl()`
`java.lang.String`	`getLoginLogoUrl()`
`int`	`getMaxConversionSize()`
`int`	`getMaxNumberDocToAdd()`
`int`	`getMaxNumberDocToModify()`
`int`	`getMaxNumberDocToPrint()`
`java.lang.String`	`getMenuPrefix()`
`boolean`	`getMergeSplitEnabled()`
`boolean`	`getMergeSplitShowCheckIn()`
`java.lang.String`	`getMessageSearchUrl()`
`boolean`	`getMobileAppAccess()`
`java.lang.String`	`getMobileBrandingCSS()` This is a generated CSS value based on Main and Seconary color.
`java.lang.String`	`getMobileBrandingDarkModeMainColor()` default value is ibmBlue50Color
`java.lang.String`	`getMobileBrandingDarkModeSecondaryColor()`
`java.lang.String`	`getMobileBrandingMainColor()` default value is ibmBlue50Color
`java.lang.String`	`getMobileBrandingSecondaryColor()`
`boolean`	`getMobileDownloadEnabled()`
`java.lang.String`	`getMobileEmailAddress()`
`java.util.Collection<InterfaceTextConfig>`	`getMobileFeatureLabelsList(java.lang.String idPrefix)`
`java.util.Collection<InterfaceTextLocaleConfig>`	`getMobileFeatureLabelsLocaleList(java.lang.String idPrefix)`
`java.util.Collection<MobileFeatureConfig>`	`getMobileFeatureList(java.lang.String idPrefix)`
`java.lang.String[]`	`getMobileFeaturesId()`
`java.lang.String`	`getMobileMaaS360DeveloperID()`
`java.lang.String`	`getMobileMaaS360LicenseKey()`
`boolean`	`getMobileMasS360Enabled()`
`boolean`	`getMobileQREnabled()`
`java.lang.String`	`getName()`
`java.lang.String`	`getObjectType()` Abstract method to return object type.
`boolean`	`getOfficeBidiSupportFlag()`
`java.lang.String`	`getOfficeCustomCommandGroupName()`
`java.util.Collection<OfficeCustomCommandConfig>`	`getOfficeCustomCommandList(java.lang.String idPrefix)`
`java.lang.String[]`	`getOfficeCustomCommandsId()`
`boolean`	`getOfficeOnlineEnabled()`
`java.lang.String`	`getOfficeTextDirection()`
`boolean`	`getOpenDocFromOtherApp()`
`java.lang.String`	`getOtherFeaturesDefaultRepository()`
`boolean`	`getOutlookPropertyRemembrance()`
`boolean`	`getOutlookUseEmailAddresses()`
`boolean`	`getOverwriteLocalOnCheckout()`
`java.lang.String`	`getPasswordRulesUrl()`
`java.lang.String[]`	`getPluginIds()`
`boolean`	`getPreventCreateNewSearch()`
`boolean`	`getPreventCreateNewUnifiedSearch()`
`boolean`	`getPrintServiceEnabled()`
`boolean`	`getPromptCloseOfficeIfDocCheckout()`
`boolean`	`getPromptForPropsOnAdd()`
`java.lang.String`	`getProperty(java.lang.String name)`
`java.lang.String`	`getRedactionAddDocumentMode()` Deprecated. 3.0.1 Use `getDocumentAddMode()` instead.
`java.lang.String`	`getRedactionSaveMode()`
`java.lang.String[]`	`getRepositoriesId()`
`java.util.Collection<RepositoryConfig>`	`getRepositoriesList(java.lang.String idPrefix)`
`RepositoryConfig`	`getRepository(java.lang.String repositoryId)` Change to get it directly instead of getting it from map to improve performance.
`java.util.Collection<RepositoryConfig>`	`getRepositoryList()`
`java.util.Map<java.lang.String,RepositoryConfig>`	`getRepositoryMap()`
`java.lang.String`	`getRibbonTabLabel()`
`boolean`	`getSendEmailAsLinkOnly()`
`ServerConfig`	`getServer(java.lang.String serverId)`
`java.util.Collection<ServerConfig>`	`getServerList()`
`java.util.Map<java.lang.String,ServerConfig>`	`getServerMap()`
`java.lang.String[]`	`getServersId()`
`java.util.Collection<ServerConfig>`	`getServersList(java.lang.String idPrefix)`
`boolean`	`getShareEnabled()`
`boolean`	`getShareMyEmailModifiable()`
`java.lang.String`	`getShareRepositoryId()`
`boolean`	`getShowContentListCheckbox()`
`boolean`	`getShowDetailsRecentlyUsed()`
`boolean`	`getShowGlobalToolbar()`
`boolean`	`getShowNoPermissionsWarning()`
`boolean`	`getShowOnlyRoleSecurity()`
`boolean`	`getShowPrimaryDocumentOnly()`
`boolean`	`getShowRoleSecurity()`
`boolean`	`getShowSecurity()`
`boolean`	`getShowSecurityInheritanceUI()`
`boolean`	`getShowStatusbar()`
`boolean`	`getShowThumbnails()`
`boolean`	`getShowViewFilmstrip()`
`boolean`	`getStreamlineEnabled()`
`boolean`	`getSupportWorkflowNotification()`
`boolean`	`getSyncEnabled()`
`java.lang.String`	`getTeamspacesDefaultRepository()`
`java.lang.String`	`getTheme()`
`boolean`	`getTimeZoneEnabled()`
`java.lang.String`	`getTimeZoneUTCOffset()`
`boolean`	`getUseFromEmailAsSender()`
`java.lang.String[]`	`getUserActionMacros()`
`java.util.Collection<UserActionMacroConfig>`	`getUserActionMacrosList(java.lang.String prefix)`
`java.lang.String`	`getViewer()`
`boolean`	`getViewInDialog()`
`java.lang.String`	`getWorkDefaultRepository()`
`boolean`	`getWorkflowRefresh()`
`boolean`	`hasRepository(java.lang.String repositoryId)` Change to not depend on getMap to improve performance
`protected void`	`initForTenant()`
`boolean`	`isAccessControlEnabled()`
`boolean`	`isAdminAccessControlEnabled()`
`boolean`	`isShowFieldHoverHelp()`
`boolean`	`isValid()`
`boolean`	`isWarning()`
`void`	`load()` Initializes the superclass default property values map.
`protected void`	`resetNonTenantSettings()`
`void`	`setAccessControlEnabled(boolean enabled)`
`void`	`setActionHandler(java.lang.String actionHandler)`
`void`	`setAddDocFoldersToRepo(boolean addDocFoldersToRepo)`
`void`	`setAddDocUsingExistingSearch(boolean addDocUsingExistingSearch)`
`void`	`setAddPhotoFromMobile(boolean addPhotoFromMobile)`
`void`	`setAddWithEntryTemplateOnly(boolean value)`
`void`	`setAdminAccessControlEnabled(boolean enabled)`
`void`	`setAdminRoleId(java.lang.String adminRoleId)`
`void`	`setAllowChangeETDuringCheckin(boolean allowChangeETDuringCheckin)`
`void`	`setAllowCollaborativeEditing(boolean allowCollaborativeEditing)`
`void`	`setAllowEmailAttachments(boolean allowEmailAttachments)`
`void`	`setApplicationName(java.lang.String applicationName)`
`void`	`setApplicationNameLabels(java.lang.String[] appNameLabels)`
`void`	`setApplicationSpaceLabels(java.lang.String[] appSpaceLabels)` ApplicationSpaceLabels is a collection of ids of repository id and application space name joined with "." for example calvinvm1ce.DefaultApplicationName
`void`	`setAsperaEnabled(boolean enabled)`
`void`	`setAsperaShowLink(boolean enabled)`
`void`	`setAuditHistoryEnabledOnDesktop(boolean auditHistoryEnabledOnDesktop)`
`void`	`setAuthenticationType(com.ibm.ecm.Constants.AuthenticationType authType)`
`void`	`setAutoCCSender(boolean autoCCSender)`
`void`	`setBannerApplicationNameColor(java.lang.String bannerApplicationNameColor)`
`void`	`setBannerBackgroundColor(java.lang.String layoutBannerColor)`
`void`	`setBannerLogoUrl(java.lang.String bannerLogoUrl)`
`void`	`setBannerMenuColor(java.lang.String layoutBannerMenuColor)`
`void`	`setBookmarkShowFeatureListEnabled(boolean bookmarkShowFeatureListEnabled)`
`void`	`setCheckoutDocumentAfterAdd(boolean value)`
`void`	`setCheckoutOnOpenDoc(boolean value)`
`void`	`setCloseTaskPaneOnOpen(boolean value)`
`void`	`setContentElementNavigation(boolean value)`
`void`	`setControlThreshold(int controlThreshold)`
`void`	`setCulturalCollation(boolean culturalCollation)`
`void`	`setDefault(java.lang.String isDefault)`
`void`	`setDefaultFeature(java.lang.String defaultFeature)`
`void`	`setDefaultRepositoryId(java.lang.String repositoryId)`
`protected void`	`setDefaultValue(java.lang.String propertyName, java.lang.String defaultValue)` Set the default value if not found in the properties object
`void`	`setDeleteEmailOnAdd(boolean value)`
`void`	`setDeleteLocalOnAdd(boolean value)`
`void`	`setDeleteLocalOnCheckin(boolean value)`
`void`	`setDeleteLocalOnSave(boolean value)`
`void`	`setDeleteOpenDocsAfterClose(boolean value)`
`void`	`setDescription(java.lang.String description)`
`void`	`setDesktopFeaturesIds(java.lang.String[] featureIds)`
`void`	`setDesktopTeyp(java.lang.String desktopType)`
`void`	`setDesktopVirtualCustomSettings(java.lang.String desktopVirtualCustomSettings)`
`void`	`setDisableAutocomplete(boolean disableAutocomplete)`
`void`	`setDisableDocumentTypeFiltering(boolean value)`
`void`	`setDocumentAddMode(java.lang.String redactionSaveMode)`
`void`	`setEditGroupAddButtonSetting(int value)`
`void`	`setEmailClientApp(java.lang.String emailClientApp)`
`void`	`setEmailClientEnabled(boolean emailClientEnabled)`
`void`	`setEmailLookAhead(boolean enableEmailLookAhead)`
`void`	`setEmailServiceEnabled(boolean emailServiceEnabled)`
`void`	`setEnableAllPlugins(boolean value)`
`void`	`setEnableHideTimePortion(boolean value)`
`void`	`setEnablePropMappingForAdd(boolean value)`
`void`	`setEntryTemplatesDefaultRepository(java.lang.String defaultRepository)`
`void`	`setFeatures(java.lang.String[] features)`
`void`	`setFileIntoFolder(boolean fileIntoFolder)`
`void`	`setFromEmailModifiable(boolean fromEmailModifiable)`
`void`	`setHelpUrl(java.lang.String helpUrl)`
`void`	`setHideEntryTemplateNotFoundWarning(boolean hideEntryTemplateNotFoundWarning)`
`void`	`setHideSaveDocument(boolean value)`
`void`	`setHideSearchActions(boolean value)`
`void`	`setIndicateManagedEmailOnAdd(boolean value)`
`void`	`setLayout(java.lang.String layout)`
`void`	`setLayoutLogFile(java.lang.String logFile)`
`void`	`setLoginInformationUrl(java.lang.String loginInformationUrl)`
`void`	`setLoginLogoUrl(java.lang.String loginLogoUrl)`
`void`	`setMaxConversionSize(int maxConversionSize)`
`void`	`setMaxNumberDocToAdd(int maxNumberDocToAdd)`
`void`	`setMaxNumberDocToModify(int maxNumberDocToModify)`
`void`	`setMaxNumberDocToPrint(int maxNumberDocToPrint)`
`void`	`setMenuPrefix(java.lang.String menuPrefix)`
`void`	`setMergeSplitEnabled(boolean enabled)`
`void`	`setMergeSplitShowCheckIn(boolean enabled)`
`void`	`setMessageSearchUrl(java.lang.String messageSearchUrl)`
`void`	`setMobileAppAccess(boolean mobileAppAccess)`
`void`	`setMobileBrandingCSS(java.lang.String value)`
`void`	`setMobileBrandingDarkModeMainColor(java.lang.String value)`
`void`	`setMobileBrandingDarkModeSecondaryColor(java.lang.String value)`
`void`	`setMobileBrandingMainColor(java.lang.String value)`
`void`	`setMobileBrandingSecondaryColor(java.lang.String value)`
`void`	`setMobileDownloadEnabled(boolean value)`
`void`	`setMobileEmailAddress(java.lang.String value)`
`void`	`setMobileFeaturesId(java.lang.String[] featureIds)`
`void`	`setMobileMaaS360DeveloperID(java.lang.String value)`
`void`	`setMobileMaaS360LicenseKey(java.lang.String value)`
`void`	`setMobileMasS360Enabled(boolean value)`
`void`	`setMobileQREnabled(boolean mobileQREnabled)`
`void`	`setName(java.lang.String name)`
`void`	`setOfficeBidiSupportFlag(boolean value)`
`void`	`setOfficeCustomCommandGroupName(java.lang.String value)`
`void`	`setOfficeCustomCommandsId(java.lang.String[] commandIds)`
`void`	`setOfficeOnlineEnabled(boolean officeOnlineEnabled)`
`void`	`setOfficeTextDirection(java.lang.String value)`
`void`	`setOpenDocFromOtherApp(boolean openDocFromOtherApp)`
`void`	`setOtherFeaturesDefaultRepository(java.lang.String defaultRepository)`
`void`	`setOutlookPropertyRemembrance(boolean outlookPropertyRemembrance)`
`void`	`setOutlookUseEmailAddresses(boolean value)`
`void`	`setOverwriteLocalOnCheckout(boolean value)`
`void`	`setPasswordRulesUrl(java.lang.String passwordRulesUrl)`
`void`	`setPluginIds(java.lang.String[] pluginIds)`
`void`	`setPluginValues(javax.servlet.http.HttpServletRequest request, com.ibm.json.java.JSONObject jsonObject)`
`void`	`setPreventCreateNewSearch(boolean preventCreateNewSearch)`
`void`	`setPreventCreateNewUnifiedSearch(boolean preventCreateNewUnifiedSearch)`
`void`	`setPrintServiceEnabled(boolean enabled)`
`void`	`setPromptCloseOfficeIfDocCheckout(boolean value)`
`void`	`setPromptForPropsOnAdd(boolean value)`
`void`	`setRedactionAddDocumentMode(java.lang.String redactionSaveMode)` Deprecated. 3.0.1 Use `setDocumentAddMode` instead.
`void`	`setRedactionSaveMode(java.lang.String redactionSaveMode)`
`void`	`setRepositoriesId(java.lang.String[] repositories)`
`void`	`setRibbonTabLabel(java.lang.String value)`
`void`	`setSendEmailAsLinkOnly(boolean value)`
`void`	`setServersId(java.lang.String[] servers)`
`void`	`setShareEnabled(boolean enabled)`
`void`	`setShareMyEmailModifiable(boolean enabled)`
`void`	`setShareRepositoryId(java.lang.String repositoryId)`
`void`	`setShowContentListCheckbox(boolean showContentListCheckbox)`
`void`	`setShowDetailsRecentlyUsed(boolean value)`
`void`	`setShowFieldHoverHelp(boolean showFieldHoverHelp)`
`void`	`setShowGlobalToolbar(boolean showGlobalToolbar)`
`void`	`setShowNoPermissionsWarning(boolean value)`
`void`	`setShowOnlyRoleSecurity(boolean showOnlyRoleSecurity)`
`void`	`setShowPrimaryDocumentOnly(boolean showPrimaryDocumentOnly)`
`void`	`setShowRoleSecurity(boolean showRoleSecurity)`
`void`	`setShowSecurity(boolean showSecurity)`
`void`	`setShowSecurityInheritanceUI(boolean showSecurityInheritanceUI)`
`void`	`setShowStatusbar(boolean showStatusbar)`
`void`	`setShowThumbnails(boolean showThumbnails)`
`void`	`setShowViewFilmstrip(boolean showViewFilmstrip)`
`void`	`setStreamlineEnabled(boolean streamlineEnabled)`
`void`	`setSupportWorkflowNotification(boolean supportNotification)`
`void`	`setSyncEnabled(boolean syncEnabled)`
`void`	`setTeamspacesDefaultRepository(java.lang.String defaultRepository)`
`void`	`setTheme(java.lang.String theme)`
`void`	`setTimeZoneEnabled(boolean value)`
`void`	`setTimeZoneUTCOffset(java.lang.String value)`
`void`	`setUseFromEmailAsSender(boolean useFromEmailAsSender)`
`void`	`setUserActionMacros(java.lang.String[] userActionMacros)`
`void`	`setValid(boolean value)`
`void`	`setValues(com.ibm.json.java.JSONObject json, boolean forceUpdate, boolean isJSONModel, boolean isDesktopAdmin, java.lang.String appName)`
`void`	`setViewer(java.lang.String viewer)`
`void`	`setViewInDialog(boolean viewInDialog)`
`void`	`setWarning(boolean value)`
`void`	`setWorkDefaultRepository(java.lang.String defaultRepository)`
`void`	`setWorkflowRefresh(boolean refresh)`
`java.lang.String`	`toString()` Override to return the object ID of this configuration back.

Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject
addIdNameToJSONModel, addValueToList, arrayToString, arrayToString, clone, covertEmptyStringtoNull, createJSONModelField, createJSONModelToggleField, createJSONModelValidationField, dump, fromJSONModel, getBooleanPropertyValue, getConfigurationObject, getDataTypeValue, getDoublePropertyValue, getIdPrefix, getIntPropertyValue, getKey, getLongPropertyValue, getMap, getObjectId, getObjectIdAlias, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, hasProperties, isEmpty, isNew, performSyncedUpdate, propertiesToString, removeValuesFromList, removeValuesFromList, returnCopyFromCache, save, setProperties, setProperty, setValues, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toJSON, toJSONModel, validate, validateObjectId, writeConfigurationToFile

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DesktopConfig

public DesktopConfig(org.apache.commons.configuration.Configuration configuration,
                     java.lang.String idPrefix,
                     java.lang.String id)

Method Detail

load
```
public void load()
```
Initializes the superclass default property values map.

Overrides:

load in class ConfigurationObject

Since:

2.0.3.8

setDefaultValue
```
protected void setDefaultValue(java.lang.String propertyName,
                               java.lang.String defaultValue)
```
Description copied from class: ConfigurationObject

Set the default value if not found in the properties object

Overrides:

setDefaultValue in class ConfigurationObject

Parameters:

propertyName - - A string value of property name.

defaultValue - - A string value of default value if not found.

getDataType
```
protected java.lang.Class getDataType(java.lang.String key)
```
Description copied from class: ConfigurationObject

Returns the datatype of a configuration property. This is implemented in subclasses and is used to properly serialize the properties. The default implementation returns null which indicates that compatible behavior should be used, which inspects the property value itself and guesses at the type of the property.

Overrides:

getDataType in class ConfigurationObject

Parameters:

key - ths name of the property

Returns:

a Class instance describing the datatype of the property.

getObjectType
```
public java.lang.String getObjectType()
```
Description copied from class: ConfigurationObject

Abstract method to return object type.

Specified by:

getObjectType in class ConfigurationObject

Returns:

a string object type back, for example "desktop", "repository"...

getName
```
public java.lang.String getName()
```
Overrides:

getName in class ConfigurationObject

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getDefault
```
public java.lang.String getDefault()
```

setDefault

public void setDefault(java.lang.String isDefault)

getFileIntoFolder
```
public boolean getFileIntoFolder()
```

setFileIntoFolder

public void setFileIntoFolder(boolean fileIntoFolder)

getShowSecurity
```
public boolean getShowSecurity()
```

setShowSecurity

public void setShowSecurity(boolean showSecurity)

getShowSecurityInheritanceUI

public boolean getShowSecurityInheritanceUI()

setShowSecurityInheritanceUI

public void setShowSecurityInheritanceUI(boolean showSecurityInheritanceUI)

getServersId

public java.lang.String[] getServersId()

setServersId

public void setServersId(java.lang.String[] servers)

getAssignedMobileFeaturesId

public java.lang.String[] getAssignedMobileFeaturesId()

getMobileFeaturesId

public java.lang.String[] getMobileFeaturesId()

setMobileFeaturesId

public void setMobileFeaturesId(java.lang.String[] featureIds)

getOfficeCustomCommandsId

public java.lang.String[] getOfficeCustomCommandsId()

Since:: 2.0.3

setOfficeCustomCommandsId

public void setOfficeCustomCommandsId(java.lang.String[] commandIds)

Since:: 2.0.3

getDesktopFeaturesIds

public java.lang.String[] getDesktopFeaturesIds()

Since:: 2.0.3

setDesktopFeaturesIds

public void setDesktopFeaturesIds(java.lang.String[] featureIds)

Since:: 2.0.3

getSyncEnabled
```
public boolean getSyncEnabled()
```
Returns:

Since:

2.0.3

setSyncEnabled

public void setSyncEnabled(boolean syncEnabled)

Parameters:: syncEnabled -
Since:: 2.0.3

getStreamlineEnabled
```
public boolean getStreamlineEnabled()
```
Returns:

Since:

2.0.3.8

setStreamlineEnabled

public void setStreamlineEnabled(boolean streamlineEnabled)

Parameters:: streamlineEnabled -
Since:: 2.0.3.8

getMobileQREnabled
```
public boolean getMobileQREnabled()
```
Returns:

Since:

3.0.1

setMobileQREnabled

public void setMobileQREnabled(boolean mobileQREnabled)

Parameters:: mobileQREnabled -
Since:: 3.0.1

getBookmarkShowFeatureListEnabled
```
public boolean getBookmarkShowFeatureListEnabled()
```
Returns:

Since:

3.0.13

setBookmarkShowFeatureListEnabled

public void setBookmarkShowFeatureListEnabled(boolean bookmarkShowFeatureListEnabled)

Parameters:: bookmarkShowFeatureListEnabled -
Since:: 3.0.13

getAuditHistoryEnabledOnDesktop

public boolean getAuditHistoryEnabledOnDesktop()

Returns:
Since:: 3.0.9

setAuditHistoryEnabledOnDesktop

public void setAuditHistoryEnabledOnDesktop(boolean auditHistoryEnabledOnDesktop)

Parameters:: auditHistoryEnabledOnDesktop -
Since:: 3.0.9

getShareEnabled
```
public boolean getShareEnabled()
```
Since:

2.0.3.5

setShareEnabled

public void setShareEnabled(boolean enabled)

Since:: 2.0.3.5

getShareMyEmailModifiable

public boolean getShareMyEmailModifiable()

Since:: 2.0.3.5

setShareMyEmailModifiable

public void setShareMyEmailModifiable(boolean enabled)

Since:: 2.0.3.5

getShareRepositoryId

public java.lang.String getShareRepositoryId()

Since:: 2.0.3.5

setShareRepositoryId

public void setShareRepositoryId(java.lang.String repositoryId)

Since:: 2.0.3.5

getEmailServiceEnabled

public boolean getEmailServiceEnabled()

Since:: 2.0.3.8

setEmailServiceEnabled

public void setEmailServiceEnabled(boolean emailServiceEnabled)

Since:: 2.0.3.8

getFromEmailModifiable

public boolean getFromEmailModifiable()

Since:: 2.0.3.8

setFromEmailModifiable

public void setFromEmailModifiable(boolean fromEmailModifiable)

Since:: 2.0.3.8

getUseFromEmailAsSender

public boolean getUseFromEmailAsSender()

Since:: 2.0.3.8

setUseFromEmailAsSender

public void setUseFromEmailAsSender(boolean useFromEmailAsSender)

Since:: 2.0.3.8

getAutoCCSender
```
public boolean getAutoCCSender()
```
Since:

3.0.9

setAutoCCSender

public void setAutoCCSender(boolean autoCCSender)

Since:: 3.0.9

getEmailLookAhead
```
public boolean getEmailLookAhead()
```
Since:

3.0.11

setEmailLookAhead

public void setEmailLookAhead(boolean enableEmailLookAhead)

Since:: 3.0.11

setAllowEmailAttachments

public void setAllowEmailAttachments(boolean allowEmailAttachments)

Since:: 3.0.10

getAllowEmailAttachments

public boolean getAllowEmailAttachments()

Since:: 3.0.10

getEmailClientEnabled

public boolean getEmailClientEnabled()

Since:: 3.0.10

setEmailClientEnabled

public void setEmailClientEnabled(boolean emailClientEnabled)

Since:: 3.0.10

getEmailClientApp

public java.lang.String getEmailClientApp()

Since:: 3.0.10

setEmailClientApp

public void setEmailClientApp(java.lang.String emailClientApp)

Since:: 3.0.10

getRepositoriesId

public java.lang.String[] getRepositoriesId()

setRepositoriesId

public void setRepositoriesId(java.lang.String[] repositories)

getMenuPrefix

public java.lang.String getMenuPrefix()

setMenuPrefix

public void setMenuPrefix(java.lang.String menuPrefix)

getHelpUrl
```
public java.lang.String getHelpUrl()
```

setHelpUrl

public void setHelpUrl(java.lang.String helpUrl)

getKCHelpTaxonomy

public java.lang.String getKCHelpTaxonomy()

getKCHelpContext

public java.lang.String getKCHelpContext()

getKCHelpWelcomeFile

public java.lang.String getKCHelpWelcomeFile()

getMessageSearchUrl

public java.lang.String getMessageSearchUrl()

setMessageSearchUrl

public void setMessageSearchUrl(java.lang.String messageSearchUrl)

getApplicationName

public java.lang.String getApplicationName()

setApplicationName

public void setApplicationName(java.lang.String applicationName)

getLoginLogoUrl

public java.lang.String getLoginLogoUrl()

setLoginLogoUrl

public void setLoginLogoUrl(java.lang.String loginLogoUrl)

getBannerLogoUrl

public java.lang.String getBannerLogoUrl()

setBannerLogoUrl

public void setBannerLogoUrl(java.lang.String bannerLogoUrl)

getLoginInformationUrl

public java.lang.String getLoginInformationUrl()

setLoginInformationUrl

public void setLoginInformationUrl(java.lang.String loginInformationUrl)

getPasswordRulesUrl

public java.lang.String getPasswordRulesUrl()

setPasswordRulesUrl

public void setPasswordRulesUrl(java.lang.String passwordRulesUrl)

isShowFieldHoverHelp
```
public boolean isShowFieldHoverHelp()
```

setShowFieldHoverHelp

public void setShowFieldHoverHelp(boolean showFieldHoverHelp)

isValid
```
public boolean isValid()
```
Specified by:

isValid in interface ConfigurationValidation

Since:

2.0.2

setValid
```
public void setValid(boolean value)
```
Specified by:

setValid in interface ConfigurationValidation

Since:

2.0.2

isWarning
```
public boolean isWarning()
```
Since:

2.0.3.6

setWarning

public void setWarning(boolean value)

Since:: 2.0.3.6

isAccessControlEnabled

public boolean isAccessControlEnabled()

Since:: 2.0.2

setAccessControlEnabled

public void setAccessControlEnabled(boolean enabled)

Since:: 2.0.2

isAdminAccessControlEnabled

public boolean isAdminAccessControlEnabled()

setAdminAccessControlEnabled

public void setAdminAccessControlEnabled(boolean enabled)

getServerList

public java.util.Collection<ServerConfig> getServerList()

getServerMap

public java.util.Map<java.lang.String,ServerConfig> getServerMap()

getServer

public ServerConfig getServer(java.lang.String serverId)

getRepositoryList

public java.util.Collection<RepositoryConfig> getRepositoryList()

getRepositoryMap

public java.util.Map<java.lang.String,RepositoryConfig> getRepositoryMap()

getRepository
```
public RepositoryConfig getRepository(java.lang.String repositoryId)
```
Change to get it directly instead of getting it from map to improve performance.

Parameters:

repositoryId -

Returns:

hasRepository
```
public boolean hasRepository(java.lang.String repositoryId)
```
Change to not depend on getMap to improve performance

Parameters:

repositoryId -

Returns:

getDefaultRepositoryId

public java.lang.String getDefaultRepositoryId()

setDefaultRepositoryId

public void setDefaultRepositoryId(java.lang.String repositoryId)

getLayout
```
public java.lang.String getLayout()
```

setLayout

public void setLayout(java.lang.String layout)

getFeatures

public java.lang.String[] getFeatures()

setFeatures

public void setFeatures(java.lang.String[] features)

getDefaultFeature

public java.lang.String getDefaultFeature()

setDefaultFeature

public void setDefaultFeature(java.lang.String defaultFeature)

getLayoutLogFile

public java.lang.String getLayoutLogFile()

setLayoutLogFile

public void setLayoutLogFile(java.lang.String logFile)

getBannerBackgroundColor

public java.lang.String getBannerBackgroundColor()

setBannerBackgroundColor

public void setBannerBackgroundColor(java.lang.String layoutBannerColor)

getBannerApplicationNameColor

public java.lang.String getBannerApplicationNameColor()

setBannerApplicationNameColor

public void setBannerApplicationNameColor(java.lang.String bannerApplicationNameColor)

getBannerMenuColor

public java.lang.String getBannerMenuColor()

setBannerMenuColor

public void setBannerMenuColor(java.lang.String layoutBannerMenuColor)

getTeamspacesDefaultRepository

public java.lang.String getTeamspacesDefaultRepository()

setTeamspacesDefaultRepository

public void setTeamspacesDefaultRepository(java.lang.String defaultRepository)

getWorkDefaultRepository

public java.lang.String getWorkDefaultRepository()

setWorkDefaultRepository

public void setWorkDefaultRepository(java.lang.String defaultRepository)

getEntryTemplatesDefaultRepository

public java.lang.String getEntryTemplatesDefaultRepository()

Since:: 2.0.3

setEntryTemplatesDefaultRepository

public void setEntryTemplatesDefaultRepository(java.lang.String defaultRepository)

Since:: 2.0.3

getOtherFeaturesDefaultRepository

public java.lang.String getOtherFeaturesDefaultRepository()

setOtherFeaturesDefaultRepository

public void setOtherFeaturesDefaultRepository(java.lang.String defaultRepository)

getShowThumbnails
```
public boolean getShowThumbnails()
```

setShowThumbnails

public void setShowThumbnails(boolean showThumbnails)

getShowViewFilmstrip
```
public boolean getShowViewFilmstrip()
```
Since:

2.0.2

setShowViewFilmstrip

public void setShowViewFilmstrip(boolean showViewFilmstrip)

Since:: 2.0.2

getShowGlobalToolbar
```
public boolean getShowGlobalToolbar()
```

setShowGlobalToolbar

public void setShowGlobalToolbar(boolean showGlobalToolbar)

getShowContentListCheckbox

public boolean getShowContentListCheckbox()

Since:: 3.0.6

setShowContentListCheckbox

public void setShowContentListCheckbox(boolean showContentListCheckbox)

Since:: 3.0.6

getActionHandler

public java.lang.String getActionHandler()

setActionHandler

public void setActionHandler(java.lang.String actionHandler)

getViewer
```
public java.lang.String getViewer()
```

setViewer

public void setViewer(java.lang.String viewer)

getDesktopVirtualCustomSettings

public java.lang.String getDesktopVirtualCustomSettings()

setDesktopVirtualCustomSettings

public void setDesktopVirtualCustomSettings(java.lang.String desktopVirtualCustomSettings)

getTheme
```
public java.lang.String getTheme()
```

setTheme

public void setTheme(java.lang.String theme)

getProperty

public java.lang.String getProperty(java.lang.String name)

setApplicationSpaceLabels
```
public void setApplicationSpaceLabels(java.lang.String[] appSpaceLabels)
```
ApplicationSpaceLabels is a collection of ids of repository id and application space name joined with "." for example calvinvm1ce.DefaultApplicationName

Parameters:

appSpaceLabels -

getApplicationSpaceLabels

public java.lang.String[] getApplicationSpaceLabels()

setApplicationNameLabels

public void setApplicationNameLabels(java.lang.String[] appNameLabels)

getApplicationNameLabels

public java.lang.String[] getApplicationNameLabels()

getList
```
public java.util.Collection getList(java.lang.String type,
                                    java.lang.String appName,
                                    javax.servlet.http.HttpServletRequest request)
```
Description copied from class: ConfigurationObject

Abstract method that needs to be override in concrete class to a return a collection back by type.

Overrides:

getList in class ConfigurationObject

Parameters:

type - - A string value of object type.

appName - - A string value of application name.

request - - A HttpServletRequest object.

Returns:

a collection of type.

getMobileFeatureList

public java.util.Collection<MobileFeatureConfig> getMobileFeatureList(java.lang.String idPrefix)

getFeatureLabelsList

public java.util.Collection<InterfaceTextConfig> getFeatureLabelsList(java.lang.String idPrefix)

getLocalizedFeatureLabel

public static java.lang.String getLocalizedFeatureLabel(MobileFeatureConfig mobileConfig,
                                                        java.util.Locale locale)

Parameters:: mobileConfig -; locale -
Returns:

getOfficeCustomCommandList

public java.util.Collection<OfficeCustomCommandConfig> getOfficeCustomCommandList(java.lang.String idPrefix)

Since:: 2.0.3

getOfficeBidiSupportFlag

public boolean getOfficeBidiSupportFlag()

Since:: 2.0.3

setOfficeBidiSupportFlag

public void setOfficeBidiSupportFlag(boolean value)

Since:: 2.0.3

getOfficeTextDirection

public java.lang.String getOfficeTextDirection()

Since:: 2.0.3

setOfficeTextDirection

public void setOfficeTextDirection(java.lang.String value)

Since:: 2.0.3

getRepositoriesList

public java.util.Collection<RepositoryConfig> getRepositoriesList(java.lang.String idPrefix)

getServersList

public java.util.Collection<ServerConfig> getServersList(java.lang.String idPrefix)

getApplicationSpaceLabelsList

public java.util.Collection<InterfaceTextConfig> getApplicationSpaceLabelsList(java.lang.String idPrefix)

getApplicationNameLabelsList

public java.util.Collection<InterfaceTextConfig> getApplicationNameLabelsList(java.lang.String idPrefix)

getMobileFeatureLabelsList

public java.util.Collection<InterfaceTextConfig> getMobileFeatureLabelsList(java.lang.String idPrefix)

Since:: 2.0.2

getApplicationSpaceLabelsLocaleList

public java.util.Collection<InterfaceTextLocaleConfig> getApplicationSpaceLabelsLocaleList(java.lang.String idPrefix)

Since:: 2.0.2

getMobileFeatureLabelsLocaleList

public java.util.Collection<InterfaceTextLocaleConfig> getMobileFeatureLabelsLocaleList(java.lang.String idPrefix)

Since:: 2.0.2

getApplicationNameLabelsLocaleList

public java.util.Collection<InterfaceTextLocaleConfig> getApplicationNameLabelsLocaleList(java.lang.String idPrefix)

getLocalizedAppSpaceLabel

public static java.lang.String getLocalizedAppSpaceLabel(java.util.Collection<InterfaceTextConfig> list,
                                                         java.lang.String repositoryId,
                                                         java.lang.String appSpace,
                                                         java.util.Locale locale)

delete
```
public void delete()
```
Deletes the related mobile application feature, interface text, and interface text locale object from the configuration store.

Overrides:

delete in class ConfigurationObject

Since:

2.0.2

exportInterfaceText

public void exportInterfaceText(java.lang.String appName,
                                java.io.OutputStreamWriter osw)
                         throws java.io.IOException,
                                java.io.FileNotFoundException

Throws:: java.io.IOException; java.io.FileNotFoundException
Since:: 2.0.2

exportMobileFeature

public void exportMobileFeature(java.lang.String appName,
                                java.io.OutputStreamWriter osw)
                         throws java.io.IOException,
                                java.io.FileNotFoundException

Throws:: java.io.IOException; java.io.FileNotFoundException
Since:: 2.0.2

exportDesktopFeatures

public void exportDesktopFeatures(java.lang.String appName,
                                  java.io.OutputStreamWriter osw)
                           throws java.io.IOException,
                                  java.io.FileNotFoundException

Throws:: java.io.IOException; java.io.FileNotFoundException
Since:: 2.0.3

exportSecurity

public void exportSecurity(java.lang.String appName,
                           java.io.OutputStreamWriter osw)
                    throws java.io.IOException,
                           java.io.FileNotFoundException

Throws:: java.io.IOException; java.io.FileNotFoundException
Since:: 2.0.2

setSupportWorkflowNotification

public void setSupportWorkflowNotification(boolean supportNotification)

getSupportWorkflowNotification

public boolean getSupportWorkflowNotification()

setWorkflowRefresh

public void setWorkflowRefresh(boolean refresh)

getWorkflowRefresh
```
public boolean getWorkflowRefresh()
```

setPreventCreateNewSearch

public void setPreventCreateNewSearch(boolean preventCreateNewSearch)

Since:: 2.0.2

getPreventCreateNewSearch

public boolean getPreventCreateNewSearch()

Since:: 2.0.2

setPreventCreateNewUnifiedSearch

public void setPreventCreateNewUnifiedSearch(boolean preventCreateNewUnifiedSearch)

Since:: 2.0.2

getPreventCreateNewUnifiedSearch

public boolean getPreventCreateNewUnifiedSearch()

Since:: 2.0.2

setHideEntryTemplateNotFoundWarning

public void setHideEntryTemplateNotFoundWarning(boolean hideEntryTemplateNotFoundWarning)

Since:: 2.0.3.5

getHideEntryTemplateNotFoundWarning

public boolean getHideEntryTemplateNotFoundWarning()

Since:: 2.0.3.5

setShowRoleSecurity

public void setShowRoleSecurity(boolean showRoleSecurity)

setShowOnlyRoleSecurity

public void setShowOnlyRoleSecurity(boolean showOnlyRoleSecurity)

getShowRoleSecurity
```
public boolean getShowRoleSecurity()
```
Since:

2.0.3.5

getShowOnlyRoleSecurity

public boolean getShowOnlyRoleSecurity()

setShowPrimaryDocumentOnly

public void setShowPrimaryDocumentOnly(boolean showPrimaryDocumentOnly)

getShowPrimaryDocumentOnly

public boolean getShowPrimaryDocumentOnly()

Since:: 2.0.3.5

setViewInDialog

public void setViewInDialog(boolean viewInDialog)

getViewInDialog
```
public boolean getViewInDialog()
```
Since:

3.0.7

getAddDocUsingExistingSearch

public boolean getAddDocUsingExistingSearch()

Since:: 3.0.11

setAddDocUsingExistingSearch

public void setAddDocUsingExistingSearch(boolean addDocUsingExistingSearch)

getAllowChangeETDuringCheckin

public boolean getAllowChangeETDuringCheckin()

Since:: 3.0.14

setAllowChangeETDuringCheckin

public void setAllowChangeETDuringCheckin(boolean allowChangeETDuringCheckin)

setMaxNumberDocToAdd

public void setMaxNumberDocToAdd(int maxNumberDocToAdd)

getMaxNumberDocToAdd
```
public int getMaxNumberDocToAdd()
```

setControlThreshold

public void setControlThreshold(int controlThreshold)

Since:: 2.0.3.6

getControlThreshold
```
public int getControlThreshold()
```
Since:

2.0.3.6

setMaxConversionSize
```
public void setMaxConversionSize(int maxConversionSize)
```
Parameters:

maxConversionSize -

Since:

2.0.3

getMaxConversionSize
```
public int getMaxConversionSize()
```
Returns:

Since:

2.03

setMaxNumberDocToModify

public void setMaxNumberDocToModify(int maxNumberDocToModify)

Since:: 2.0.2

getMaxNumberDocToModify
```
public int getMaxNumberDocToModify()
```
Since:

2.0.2

getDisableAutocomplete

public boolean getDisableAutocomplete()

setDisableAutocomplete

public void setDisableAutocomplete(boolean disableAutocomplete)

getCulturalCollation
```
public boolean getCulturalCollation()
```

setCulturalCollation

public void setCulturalCollation(boolean culturalCollation)

setTimeZoneEnabled

public void setTimeZoneEnabled(boolean value)

getTimeZoneEnabled
```
public boolean getTimeZoneEnabled()
```

setTimeZoneUTCOffset

public void setTimeZoneUTCOffset(java.lang.String value)

getTimeZoneUTCOffset

public java.lang.String getTimeZoneUTCOffset()

setEnableHideTimePortion

public void setEnableHideTimePortion(boolean value)

getEnableHideTimePortion

public boolean getEnableHideTimePortion()

getCheckoutOnOpenDoc
```
public boolean getCheckoutOnOpenDoc()
```

setCheckoutOnOpenDoc

public void setCheckoutOnOpenDoc(boolean value)

getPromptCloseOfficeIfDocCheckout

public boolean getPromptCloseOfficeIfDocCheckout()

setPromptCloseOfficeIfDocCheckout

public void setPromptCloseOfficeIfDocCheckout(boolean value)

getDeleteLocalOnAdd
```
public boolean getDeleteLocalOnAdd()
```
Since:

2.0.3.5

setDeleteLocalOnAdd

public void setDeleteLocalOnAdd(boolean value)

Since:: 2.0.3.5

getDeleteLocalOnCheckin

public boolean getDeleteLocalOnCheckin()

Since:: 2.0.3.5

setDeleteLocalOnCheckin

public void setDeleteLocalOnCheckin(boolean value)

Since:: 2.0.3.5

getDeleteLocalOnSave
```
public boolean getDeleteLocalOnSave()
```

setDeleteLocalOnSave

public void setDeleteLocalOnSave(boolean value)

getAddWithEntryTemplateOnly

public boolean getAddWithEntryTemplateOnly()

setAddWithEntryTemplateOnly

public void setAddWithEntryTemplateOnly(boolean value)

getPromptForPropsOnAdd

public boolean getPromptForPropsOnAdd()

setPromptForPropsOnAdd

public void setPromptForPropsOnAdd(boolean value)

getDeleteEmailOnAdd
```
public boolean getDeleteEmailOnAdd()
```

setDeleteEmailOnAdd

public void setDeleteEmailOnAdd(boolean value)

getIndicateManagedEmailOnAdd

public boolean getIndicateManagedEmailOnAdd()

Since:: 2.0.3

setIndicateManagedEmailOnAdd

public void setIndicateManagedEmailOnAdd(boolean value)

Since:: 2.0.3

getSendEmailAsLinkOnly

public boolean getSendEmailAsLinkOnly()

setSendEmailAsLinkOnly

public void setSendEmailAsLinkOnly(boolean value)

getEnablePropMappingForAdd

public boolean getEnablePropMappingForAdd()

setEnablePropMappingForAdd

public void setEnablePropMappingForAdd(boolean value)

getDisableDocumentTypeFiltering

public boolean getDisableDocumentTypeFiltering()

Since:: 2.0.3

setDisableDocumentTypeFiltering

public void setDisableDocumentTypeFiltering(boolean value)

Since:: 2.0.3

getShowDetailsRecentlyUsed

public boolean getShowDetailsRecentlyUsed()

Since:: 2.0.3.5

setShowDetailsRecentlyUsed

public void setShowDetailsRecentlyUsed(boolean value)

Since:: 2.0.3.5

getShowNoPermissionsWarning

public boolean getShowNoPermissionsWarning()

Since:: 2.0.3.5

setShowNoPermissionsWarning

public void setShowNoPermissionsWarning(boolean value)

Since:: 2.0.3.5

getHideSearchActions
```
public boolean getHideSearchActions()
```
Since:

2.0.3.5

setHideSearchActions

public void setHideSearchActions(boolean value)

Since:: 2.0.3.5

getHideSaveDocument
```
public boolean getHideSaveDocument()
```
Since:

2.0.3.1

setHideSaveDocument

public void setHideSaveDocument(boolean value)

Since:: 2.0.3.1

getEditGroupAddButtonSetting

public int getEditGroupAddButtonSetting()

Since:: 2.0.3

setEditGroupAddButtonSetting

public void setEditGroupAddButtonSetting(int value)

Since:: 2.0.3

getDeleteOpenDocsAfterClose

public boolean getDeleteOpenDocsAfterClose()

setDeleteOpenDocsAfterClose

public void setDeleteOpenDocsAfterClose(boolean value)

getCheckoutDocumentAfterAdd

public boolean getCheckoutDocumentAfterAdd()

Since:: 2.0.3.5

setCheckoutDocumentAfterAdd

public void setCheckoutDocumentAfterAdd(boolean value)

Since:: 2.0.3.5

getOfficeCustomCommandGroupName

public java.lang.String getOfficeCustomCommandGroupName()

Since:: 2.0.3

setOfficeCustomCommandGroupName

public void setOfficeCustomCommandGroupName(java.lang.String value)

Since:: 2.0.3

getRibbonTabLabel

public java.lang.String getRibbonTabLabel()

Since:: 2.0.3

setRibbonTabLabel

public void setRibbonTabLabel(java.lang.String value)

Since:: 2.0.3

getCloseTaskPaneOnOpen

public boolean getCloseTaskPaneOnOpen()

Since:: 2.0.3

setCloseTaskPaneOnOpen

public void setCloseTaskPaneOnOpen(boolean value)

Since:: 2.0.3

getOverwriteLocalOnCheckout

public boolean getOverwriteLocalOnCheckout()

Since:: 3.0.5

setOverwriteLocalOnCheckout

public void setOverwriteLocalOnCheckout(boolean value)

Since:: 3.0.5

getOutlookUseEmailAddresses

public boolean getOutlookUseEmailAddresses()

Since:: 3.0.7

setOutlookUseEmailAddresses

public void setOutlookUseEmailAddresses(boolean value)

Since:: 3.0.7

getContentElementNavigation

public boolean getContentElementNavigation()

Since:: 3.0.9

setContentElementNavigation

public void setContentElementNavigation(boolean value)

Since:: 3.0.9

getMobileAppAccess
```
public boolean getMobileAppAccess()
```

setMobileAppAccess

public void setMobileAppAccess(boolean mobileAppAccess)

getAddPhotoFromMobile

public boolean getAddPhotoFromMobile()

setAddPhotoFromMobile

public void setAddPhotoFromMobile(boolean addPhotoFromMobile)

getAddDocFoldersToRepo

public boolean getAddDocFoldersToRepo()

setAddDocFoldersToRepo

public void setAddDocFoldersToRepo(boolean addDocFoldersToRepo)

getOpenDocFromOtherApp

public boolean getOpenDocFromOtherApp()

setOpenDocFromOtherApp

public void setOpenDocFromOtherApp(boolean openDocFromOtherApp)

getAuthenticationType

public com.ibm.ecm.Constants.AuthenticationType getAuthenticationType()

Since:: 2.0.2

setAuthenticationType

public void setAuthenticationType(com.ibm.ecm.Constants.AuthenticationType authType)

Since:: 2.0.2

setPluginValues

public void setPluginValues(javax.servlet.http.HttpServletRequest request,
                            com.ibm.json.java.JSONObject jsonObject)

getUserActionMacros

public java.lang.String[] getUserActionMacros()

setUserActionMacros

public void setUserActionMacros(java.lang.String[] userActionMacros)

getUserActionMacrosList

public java.util.Collection<UserActionMacroConfig> getUserActionMacrosList(java.lang.String prefix)

getDesktopFeatureList

public java.util.Collection<DesktopFeatureConfig> getDesktopFeatureList(java.lang.String idPrefix)

Since:: 2.0.3

getShowStatusbar
```
public boolean getShowStatusbar()
```
Since:

2.0.3

setShowStatusbar

public void setShowStatusbar(boolean showStatusbar)

Since:: 2.0.3

getMobileBrandingCSS
```
public java.lang.String getMobileBrandingCSS()
```
This is a generated CSS value based on Main and Seconary color.

Returns:

setMobileBrandingCSS

public void setMobileBrandingCSS(java.lang.String value)

getMobileBrandingMainColor
```
public java.lang.String getMobileBrandingMainColor()
```
default value is ibmBlue50Color

Returns:

mobile main color

setMobileBrandingMainColor

public void setMobileBrandingMainColor(java.lang.String value)

getMobileBrandingSecondaryColor

public java.lang.String getMobileBrandingSecondaryColor()

setMobileBrandingSecondaryColor

public void setMobileBrandingSecondaryColor(java.lang.String value)

getMobileBrandingDarkModeMainColor
```
public java.lang.String getMobileBrandingDarkModeMainColor()
```
default value is ibmBlue50Color

Returns:

mobile main color

setMobileBrandingDarkModeMainColor

public void setMobileBrandingDarkModeMainColor(java.lang.String value)

getMobileBrandingDarkModeSecondaryColor

public java.lang.String getMobileBrandingDarkModeSecondaryColor()

setMobileBrandingDarkModeSecondaryColor

public void setMobileBrandingDarkModeSecondaryColor(java.lang.String value)

getMobileMasS360Enabled

public boolean getMobileMasS360Enabled()

setMobileMasS360Enabled

public void setMobileMasS360Enabled(boolean value)

getMobileMaaS360DeveloperID

public java.lang.String getMobileMaaS360DeveloperID()

setMobileMaaS360DeveloperID

public void setMobileMaaS360DeveloperID(java.lang.String value)

getMobileMaaS360LicenseKey

public java.lang.String getMobileMaaS360LicenseKey()

setMobileMaaS360LicenseKey

public void setMobileMaaS360LicenseKey(java.lang.String value)

getMobileEmailAddress

public java.lang.String getMobileEmailAddress()

setMobileEmailAddress

public void setMobileEmailAddress(java.lang.String value)

getMobileDownloadEnabled

public boolean getMobileDownloadEnabled()

Since:: 3.0.9 IF1

setMobileDownloadEnabled

public void setMobileDownloadEnabled(boolean value)

getEnableAllPlugins
```
public boolean getEnableAllPlugins()
```
Since:

2.0.3.7

setEnableAllPlugins

public void setEnableAllPlugins(boolean value)

Since:: 2.0.3.7

getPluginIds

public java.lang.String[] getPluginIds()

Since:: 2.0.3.7

setPluginIds

public void setPluginIds(java.lang.String[] pluginIds)

Since:: 2.0.3.7

getRedactionSaveMode

public java.lang.String getRedactionSaveMode()

Since:: 2.0.3.7

setRedactionSaveMode

public void setRedactionSaveMode(java.lang.String redactionSaveMode)

Since:: 2.0.3.7

getRedactionAddDocumentMode
```
public java.lang.String getRedactionAddDocumentMode()
```
Deprecated. 3.0.1 Use getDocumentAddMode() instead.

Since:

2.0.3.7

setRedactionAddDocumentMode
```
public void setRedactionAddDocumentMode(java.lang.String redactionSaveMode)
```
Deprecated. 3.0.1 Use setDocumentAddMode instead.

Since:

2.0.3.7

getDocumentAddMode

public java.lang.String getDocumentAddMode()

Since:: 3.0.1

setDocumentAddMode

public void setDocumentAddMode(java.lang.String redactionSaveMode)

Since:: 3.0.1

setOutlookPropertyRemembrance

public void setOutlookPropertyRemembrance(boolean outlookPropertyRemembrance)

Since:: 3.0

getOutlookPropertyRemembrance

public boolean getOutlookPropertyRemembrance()

Since:: 3.0

getOfficeOnlineEnabled

public boolean getOfficeOnlineEnabled()

Returns:
Since:: 3.0

setOfficeOnlineEnabled

public void setOfficeOnlineEnabled(boolean officeOnlineEnabled)

Parameters:: officeOnlineEnabled -
Since:: 3.0

getAllowCollaborativeEditing

public boolean getAllowCollaborativeEditing()

Returns:
Since:: 3.0

setAllowCollaborativeEditing

public void setAllowCollaborativeEditing(boolean allowCollaborativeEditing)

Parameters:: allowCollaborativeEditing -
Since:: 3.0

getMergeSplitEnabled
```
public boolean getMergeSplitEnabled()
```
Returns:

Since:

3.0.1

setMergeSplitEnabled

public void setMergeSplitEnabled(boolean enabled)

Parameters:: enabled -
Since:: 3.0.1

getMergeSplitShowCheckIn

public boolean getMergeSplitShowCheckIn()

Returns:
Since:: 3.0.1

setMergeSplitShowCheckIn

public void setMergeSplitShowCheckIn(boolean enabled)

Parameters:: enabled -
Since:: 3.0.1

getPrintServiceEnabled

public boolean getPrintServiceEnabled()

Returns:

setPrintServiceEnabled

public void setPrintServiceEnabled(boolean enabled)

getAdminRoleId

public java.lang.String getAdminRoleId()

Since 3.0.3

Returns:

setAdminRoleId

public void setAdminRoleId(java.lang.String adminRoleId)

Since:: 3.0.3

setMaxNumberDocToPrint

public void setMaxNumberDocToPrint(int maxNumberDocToPrint)

Since:: 3.0.3

getMaxNumberDocToPrint
```
public int getMaxNumberDocToPrint()
```
Since:

3.0.3

getAsperaEnabled
```
public boolean getAsperaEnabled()
```
Since:

3.0.4

setAsperaEnabled

public void setAsperaEnabled(boolean enabled)

Since:: 3.0.4

getAsperaShowLink
```
public boolean getAsperaShowLink()
```
Since:

3.0.9

setAsperaShowLink

public void setAsperaShowLink(boolean enabled)

Since:: 3.0.9

getDesktopType

public java.lang.String getDesktopType()

Since:: 3.0.5

setDesktopTeyp

public void setDesktopTeyp(java.lang.String desktopType)

Since:: 3.0.5

toString
```
public java.lang.String toString()
```
Description copied from class: ConfigurationObject

Override to return the object ID of this configuration back.

Overrides:

toString in class ConfigurationObject

setValues

public void setValues(com.ibm.json.java.JSONObject json,
                      boolean forceUpdate,
                      boolean isJSONModel,
                      boolean isDesktopAdmin,
                      java.lang.String appName)
               throws org.apache.commons.configuration.ConfigurationException,
                      MissingValueException

Throws:: org.apache.commons.configuration.ConfigurationException; MissingValueException

initForTenant

protected void initForTenant()
                      throws org.apache.commons.configuration.ConfigurationException

Throws:: org.apache.commons.configuration.ConfigurationException
Since:: 3.0.12

resetNonTenantSettings
```
protected void resetNonTenantSettings()
                               throws org.apache.commons.configuration.ConfigurationException
```
Overrides:

resetNonTenantSettings in class ConfigurationObject

Throws:

org.apache.commons.configuration.ConfigurationException

Since:

3.0.12

getDesktopId

protected java.lang.String getDesktopId()

Class DesktopConfig

Field Summary

Fields inherited from class com.ibm.ecm.configuration.ConfigurationObject

Constructor Summary

Method Summary

Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject

Methods inherited from class java.lang.Object

Constructor Detail

DesktopConfig

Method Detail

load

setDefaultValue

getDataType

getObjectType

getName

setName

getDescription

setDescription

getDefault

setDefault

getFileIntoFolder

setFileIntoFolder

getShowSecurity

setShowSecurity

getShowSecurityInheritanceUI

setShowSecurityInheritanceUI

getServersId

setServersId

getAssignedMobileFeaturesId

getMobileFeaturesId

setMobileFeaturesId

getOfficeCustomCommandsId

setOfficeCustomCommandsId

getDesktopFeaturesIds

setDesktopFeaturesIds

getSyncEnabled

setSyncEnabled

getStreamlineEnabled

setStreamlineEnabled

getMobileQREnabled

setMobileQREnabled

getBookmarkShowFeatureListEnabled

setBookmarkShowFeatureListEnabled

getAuditHistoryEnabledOnDesktop

setAuditHistoryEnabledOnDesktop

getShareEnabled

setShareEnabled

getShareMyEmailModifiable

setShareMyEmailModifiable

getShareRepositoryId

setShareRepositoryId

getEmailServiceEnabled

setEmailServiceEnabled

getFromEmailModifiable

setFromEmailModifiable

getUseFromEmailAsSender

setUseFromEmailAsSender

getAutoCCSender

setAutoCCSender

getEmailLookAhead

setEmailLookAhead

setAllowEmailAttachments

getAllowEmailAttachments

getEmailClientEnabled

setEmailClientEnabled

getEmailClientApp

setEmailClientApp

getRepositoriesId

setRepositoriesId

getMenuPrefix

setMenuPrefix

getHelpUrl

setHelpUrl

getKCHelpTaxonomy

getKCHelpContext

getKCHelpWelcomeFile

getMessageSearchUrl

setMessageSearchUrl

getApplicationName

setApplicationName