com.ibm.ecm.configuration

Class ViewerConfig

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

com.ibm.ecm.configuration.ViewerConfig

All Implemented Interfaces:

java.io.Serializable

public class ViewerConfig
extends ConfigurationObject
implements java.io.Serializable

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
ViewerConfig(org.apache.commons.configuration.Configuration configuration, java.lang.String idPrefix, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	delete() Remove this configuration object from the DB.
protected java.lang.Class	getDataType(java.lang.String key) Returns the datatype of a configuration property.
java.lang.String	getDescription()
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.
java.lang.String[]	getMappingsId()
java.lang.String	getName()
java.lang.String	getObjectType() Abstract method to return object type.
java.util.Collection<ViewerMappingConfig>	getViewerMappingList()
com.ibm.json.java.JSONArray	getViewerMappingsJSON()
java.util.Map<java.lang.String,ViewerMappingConfig>	getViewerMappingsMap()
void	setDescription(java.lang.String name)
void	setMappingsId(java.lang.String[] mappings)
void	setName(java.lang.String name)
com.ibm.json.java.JSONObject	toJSON(boolean includeDependencies) Convert this configuration object and its dependencies to JSON object to be stream back to client.

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, load, performSyncedUpdate, propertiesToString, removeValuesFromList, removeValuesFromList, resetNonTenantSettings, returnCopyFromCache, save, setDefaultValue, setProperties, setProperty, setValues, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toJSONModel, toString, validate, validateObjectId, writeConfigurationToFile

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ViewerConfig

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

Method Detail

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

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.

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.

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

Overrides:

getName in class ConfigurationObject

setDescription

public void setDescription(java.lang.String name)

getDescription

public java.lang.String getDescription()

getMappingsId

public java.lang.String[] getMappingsId()

setMappingsId

public void setMappingsId(java.lang.String[] mappings)

getViewerMappingList

public java.util.Collection<ViewerMappingConfig> getViewerMappingList()

getViewerMappingsMap

public java.util.Map<java.lang.String,ViewerMappingConfig> getViewerMappingsMap()

getViewerMappingsJSON

public com.ibm.json.java.JSONArray getViewerMappingsJSON()

delete

public void delete()

Description copied from class: ConfigurationObject

Remove this configuration object from the DB.

Overrides:

delete in class ConfigurationObject

toJSON

public com.ibm.json.java.JSONObject toJSON(boolean includeDependencies)

Description copied from class: ConfigurationObject

Convert this configuration object and its dependencies to JSON object to be stream back to client.

Overrides:

toJSON in class ConfigurationObject

Returns:

A JSONObject of this configuration