com.ibm.ecm.configuration

Class RedactionReasonConfig

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

com.ibm.ecm.configuration.RedactionReasonConfig

All Implemented Interfaces:

java.io.Serializable

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

Method Summary

Modifier and Type	Method and Description
boolean	addDcAppName(java.lang.String dcAppName) Add the Datacap application name.
void	addReasonCodeUsage(java.lang.String dcAppName, java.lang.String dcFieldName)
boolean	addRepositoryId(java.lang.String repositoryId) Add the Repository id.
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.util.Collection<java.lang.String>	getDcAppNames()
java.lang.String	getDcAppNamesString() Return as a comma-separated list for display purposes.
java.lang.String	getDescription()
java.lang.String	getId()
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	getName()
java.lang.String	getObjectType() Abstract method to return object type.
java.util.Collection<java.lang.String>	getRepositoryIds()
java.lang.String	getRepositoryIdsString()
boolean	hasRepositoryId(java.lang.String repositoryId)
int	removeDcAppName(java.lang.String dcAppName)
void	removeReasonCodeUsage(java.lang.String dcAppName, java.lang.String dcFieldName)
int	removeRepositoryId(java.lang.String repositoryId)
void	setDescription(java.lang.String name)
void	setId(java.lang.String id)
void	setName(java.lang.String name)
com.ibm.json.java.JSONObject	toJSON() Convert this configuration object to JSON object to be stream back to client.
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, load, performSyncedUpdate, propertiesToString, removeValuesFromList, removeValuesFromList, resetNonTenantSettings, returnCopyFromCache, save, setDefaultValue, setProperties, setProperty, setValues, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toJSONModel, validate, validateObjectId, writeConfigurationToFile

Methods inherited from class java.lang.Object

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

Constructor Detail

RedactionReasonConfig

public RedactionReasonConfig(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.

setId

public void setId(java.lang.String id)

getId

public java.lang.String getId()

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()

addRepositoryId

public boolean addRepositoryId(java.lang.String repositoryId)

Add the Repository id.

Parameters:

repositoryId -

Returns:

Return whether or not the value changed, and a save is required. If true, the repositoryId did not exist and was added. If false, the repositoryId already exists, so no change was needed.

removeRepositoryId

public int removeRepositoryId(java.lang.String repositoryId)

hasRepositoryId

public boolean hasRepositoryId(java.lang.String repositoryId)

getRepositoryIds

public java.util.Collection<java.lang.String> getRepositoryIds()

getRepositoryIdsString

public java.lang.String getRepositoryIdsString()

addDcAppName

public boolean addDcAppName(java.lang.String dcAppName)

Add the Datacap application name.

Parameters:

dcAppName -

Returns:

Return whether or not the value changed, and a save is required. If true, the dcAppName did not exist and was added. If false, the dcAppName already exists, so no change was needed.

removeDcAppName

public int removeDcAppName(java.lang.String dcAppName)

getDcAppNames

public java.util.Collection<java.lang.String> getDcAppNames()

getDcAppNamesString

public java.lang.String getDcAppNamesString()

Return as a comma-separated list for display purposes.

Returns:

addReasonCodeUsage

public void addReasonCodeUsage(java.lang.String dcAppName,
                               java.lang.String dcFieldName)

removeReasonCodeUsage

public void removeReasonCodeUsage(java.lang.String dcAppName,
                                  java.lang.String dcFieldName)

delete

public void delete()

Description copied from class: ConfigurationObject

Remove this configuration object from the DB.

Overrides:

delete in class ConfigurationObject

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

toJSON

public com.ibm.json.java.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