com.ibm.ecm.configuration

Class UserConfig

  1. java.lang.Object
  2. extended bycom.ibm.ecm.configuration.ConfigurationObject
  3. extended bycom.ibm.ecm.configuration.UserConfig
  1. public class UserConfig
  2. extends ConfigurationObject

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
 FAVORITE_CAP
  1. static
  2. int
 RECENT_ITEM_CAP
  1. static
  2. int
 RECENT_SEARCH_CAP
  1. static
  2. int
 RECENT_TEAMSPACE_CAP
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
UserConfig(org.apache.commons.configuration.Configuration configuration,java.lang.String idPrefix,java.lang.String id)

Method Summary

Modifier and Type Method and Description
  1. void
 addRecentItem(RecentItemConfig recentItemConfig)
  1. void
 addRecentSearch(RecentSearchConfig recentSearchConfig)
  1. void
 addRecentTeamspace(RecentTeamspaceConfig recentTeamspaceConfig)
  1. protected
  2. java.lang.Class
 getDataType(java.lang.String key)
  1. java.util.Collection<FavoriteConfig>
 getFavoriteList()
  1. java.lang.String[]
 getFavoritesId()
  1. java.util.Map<java.lang.String,FavoriteConfig>
 getFavoritesMap()
  1. java.util.Collection
 getList(java.lang.String type,java.lang.String appName,javax.servlet.http.HttpServletRequest request)
  1. java.lang.String
 getObjectType()
  1. java.util.Collection<RecentItemConfig>
 getRecentItemList()
  1. java.util.Collection<RecentSearchConfig>
 getRecentSearchList()
  1. java.util.Collection<RecentTeamspaceConfig>
 getRecentTeamspaceList()
  1. boolean
 isFavorteMax()
  1. boolean
 isRecentSearchMax()
  1. void
 removeValuesFromList(java.lang.String key,java.util.List<java.lang.String> deleteValues,java.util.Properties props)
  1. void
 save()
  1. void
 setFavoritesId(java.lang.String[] favorites)
Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject
addValueToList, arrayToString, covertEmptyStringtoNull, delete, dump, getConfigurationObject, getDataTypeValue, getIdPrefix, getKey, getMap, getName, getObjectId, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, isEmpty, load, propertiesToString, removeValuesFromList, setDefaultValue, setProperty, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toString, writeConfigurationToFile
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FAVORITE_CAP

  1. public static final int FAVORITE_CAP
See Also:
Constant Field Values

RECENT_SEARCH_CAP

  1. public static final int RECENT_SEARCH_CAP
See Also:
Constant Field Values

RECENT_TEAMSPACE_CAP

  1. public static final int RECENT_TEAMSPACE_CAP
See Also:
Constant Field Values

RECENT_ITEM_CAP

  1. public static final int RECENT_ITEM_CAP
See Also:
Constant Field Values

Constructor Detail

UserConfig

  1. public UserConfig(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.

getList

  1. public java.util.Collection getList( java.lang.String type,
  2. java.lang.String appName,
  3. 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.

getFavoritesId

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

setFavoritesId

  1. public void setFavoritesId(java.lang.String[] favorites)

getFavoriteList

  1. public java.util.Collection<FavoriteConfig> getFavoriteList( )

isFavorteMax

  1. public boolean isFavorteMax()

getFavoritesMap

  1. public java.util.Map<java.lang.String,FavoriteConfig> getFavoritesMap( )

isRecentSearchMax

  1. public boolean isRecentSearchMax( )

getRecentSearchList

  1. public java.util.Collection<RecentSearchConfig> getRecentSearchList( )

addRecentSearch

  1. public void addRecentSearch(RecentSearchConfig recentSearchConfig)
  2. throws java.io.IOException
Throws:
java.io.IOException

getRecentItemList

  1. public java.util.Collection<RecentItemConfig> getRecentItemList( )

addRecentItem

  1. public void addRecentItem(RecentItemConfig recentItemConfig)
  2. throws java.io.IOException
Throws:
java.io.IOException

getRecentTeamspaceList

  1. public java.util.Collection<RecentTeamspaceConfig> getRecentTeamspaceList( )

addRecentTeamspace

  1. public void addRecentTeamspace( RecentTeamspaceConfig recentTeamspaceConfig)
  2. throws java.io.IOException
Throws:
java.io.IOException

removeValuesFromList

  1. public void removeValuesFromList( java.lang.String key,
  2. java.util.List<java.lang.String> deleteValues,
  3. java.util.Properties props)
Overrides:
removeValuesFromList in class ConfigurationObject

save

  1. public void save()
  2. throws org.apache.commons.configuration.ConfigurationException
Description copied from class: ConfigurationObject
Saves the object back to the configuration store.
Overrides:
save in class ConfigurationObject
Throws:
org.apache.commons.configuration.ConfigurationException