com.ibm.ecm.configuration

Class DesktopFeatureConfig

  1. java.lang.Object
  2. extended bycom.ibm.ecm.configuration.ConfigurationObject
  3. extended bycom.ibm.ecm.configuration.DesktopFeatureConfig
  1. public class DesktopFeatureConfig
  2. extends ConfigurationObject
Provides a class for setting configuration settings for a selected feature.
Since:
2.0.3

Field Summary

Fields inherited from class com.ibm.ecm.configuration.ConfigurationObject
ARRAY_DELIMITER, cloned, KEY_DELIMITER, LIST_ESC_CHAR, LIST_ESCAPE, LIST_SEPARATOR, MODIFIER, properties

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
  1. protected
  2. java.lang.Class
 getDataType(java.lang.String key)
  1. java.lang.String
 getDefaultRepository()
  1. boolean
 getDocumentInfoPaneDefaultOpen()
  1. boolean
 getDocumentInfoPaneOpenOnSelection()
  1. java.lang.String
 getFeatureConfiguration()
  1. java.lang.String
 getObjectType()
  1. boolean
 getShowDocumentInfoPane()
  1. boolean
 getShowMyCheckouts()
  1. java.lang.String[]
 getShowRepositories()
  1. boolean
 getShowTreeView()
  1. java.lang.String[]
 getShowViews()
  1. void
 setDefaultRepository(java.lang.String defaultRepository)
  1. void
 setDocumentInfoPaneDefaultOpen(boolean documentInfoPaneDefaultOpen)
  1. void
 setDocumentInfoPaneOpenOnSelection(boolean documentInfoPaneOpenOnSelection)
  1. void
 setFeatureConfiguration(java.lang.String featureConfiguration)
  1. void
 setShowDocumentInfoPane(boolean showDocumentInfoPane)
  1. void
 setShowMyCheckouts(boolean showMyCheckouts)
  1. void
 setShowRepositories(java.lang.String[] repositories)
  1. void
 setShowTreeView(boolean showTreeView)
  1. void
 setShowViews(java.lang.String[] views)
  1. JSONObject
 toJSON()
  1. java.lang.String
 toString()
Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject
addValueToList, arrayToString, covertEmptyStringtoNull, delete, dump, getConfigurationObject, getDataTypeValue, getIdPrefix, getKey, getList, getMap, getName, getObjectId, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, isEmpty, load, propertiesToString, removeValuesFromList, removeValuesFromList, save, setDefaultValue, setProperty, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, writeConfigurationToFile
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DesktopFeatureConfig

  1. public DesktopFeatureConfig(org.apache.commons.configuration.Configuration configuration,
  2. java.lang.String idPrefix,
  3. java.lang.String id)

Method Detail

getObjectType

  1. 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"...

getDataType

  1. 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
Returns:
a Class instance describing the datatype of the property.

getDefaultRepository

  1. public java.lang.String getDefaultRepository( )

setDefaultRepository

  1. public void setDefaultRepository( java.lang.String defaultRepository)

getShowTreeView

  1. public boolean getShowTreeView( )

setShowTreeView

  1. public void setShowTreeView(boolean showTreeView)

getShowDocumentInfoPane

  1. public boolean getShowDocumentInfoPane( )

setShowDocumentInfoPane

  1. public void setShowDocumentInfoPane( boolean showDocumentInfoPane)

getDocumentInfoPaneDefaultOpen

  1. public boolean getDocumentInfoPaneDefaultOpen( )

setDocumentInfoPaneDefaultOpen

  1. public void setDocumentInfoPaneDefaultOpen( boolean documentInfoPaneDefaultOpen)

getDocumentInfoPaneOpenOnSelection

  1. public boolean getDocumentInfoPaneOpenOnSelection( )

setDocumentInfoPaneOpenOnSelection

  1. public void setDocumentInfoPaneOpenOnSelection( boolean documentInfoPaneOpenOnSelection)

getFeatureConfiguration

  1. public java.lang.String getFeatureConfiguration( )

setFeatureConfiguration

  1. public void setFeatureConfiguration( java.lang.String featureConfiguration)

getShowRepositories

  1. public java.lang.String[] getShowRepositories( )

setShowRepositories

  1. public void setShowRepositories( java.lang.String[] repositories)

getShowViews

  1. public java.lang.String[] getShowViews( )

setShowViews

  1. public void setShowViews(java.lang.String[] views)

setShowMyCheckouts

  1. public void setShowMyCheckouts( boolean showMyCheckouts)

getShowMyCheckouts

  1. public boolean getShowMyCheckouts( )

toString

  1. 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

toJSON

  1. public JSONObject toJSON()
Description copied from class: ConfigurationObject
Convert this configuration object to JSON object to be stream back to client. Since toJSON is using properties object directly therefore any default value is not applicable in this case. All added property after ICN 2.0.0 is required to add itself into upgrade method to support this method.
Overrides:
toJSON in class ConfigurationObject
Returns:
A JSONObject of this configuration