com.ibm.ecm.configuration

Class OfficeCustomCommandConfig

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

com.ibm.ecm.configuration.OfficeCustomCommandConfig

All Implemented Interfaces:

java.io.Serializable

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAvailable()
protected java.lang.Class	getDataType(java.lang.String key) Returns the datatype of a configuration property.
java.lang.String	getDescription()
java.lang.String	getDesktopId()
java.lang.String	getIcon()
java.lang.String	getLabel()
java.lang.String	getObjectType() Abstract method to return object type.
java.lang.String	getUrl()
void	setAvailable(java.lang.String available)
void	setDescription(java.lang.String description)
void	setDesktopId(java.lang.String desktopId)
void	setIcon(java.lang.String icon)
void	setLabel(java.lang.String label)
void	setUrl(java.lang.String url)
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, delete, dump, fromJSONModel, getBooleanPropertyValue, getConfigurationObject, getDataTypeValue, getDoublePropertyValue, getIdPrefix, getIntPropertyValue, getKey, getList, getLongPropertyValue, getMap, getName, 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

OfficeCustomCommandConfig

public OfficeCustomCommandConfig(java.lang.String id,
                                 OfficeCustomCommandConfig fromConfig)

OfficeCustomCommandConfig

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

getAvailable

public java.lang.String getAvailable()

setAvailable

public void setAvailable(java.lang.String available)

getIcon

public java.lang.String getIcon()

setIcon

public void setIcon(java.lang.String icon)

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String label)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

getDesktopId

public java.lang.String getDesktopId()

setDesktopId

public void setDesktopId(java.lang.String desktopId)

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