com.ibm.ecm.configuration

Class OfficeCustomCommandConfig

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

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

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
 getAvailable()
  1. protected
  2. java.lang.Class
 getDataType(java.lang.String key)
  1. java.lang.String
 getDescription()
  1. java.lang.String
 getDesktopId()
  1. java.lang.String
 getIcon()
  1. java.lang.String
 getLabel()
  1. java.lang.String
 getObjectType()
  1. java.lang.String
 getUrl()
  1. void
 setAvailable(java.lang.String available)
  1. void
 setDescription(java.lang.String description)
  1. void
 setDesktopId(java.lang.String desktopId)
  1. void
 setIcon(java.lang.String icon)
  1. void
 setLabel(java.lang.String label)
  1. void
 setUrl(java.lang.String url)
  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

OfficeCustomCommandConfig

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

getAvailable

  1. public java.lang.String getAvailable( )

setAvailable

  1. public void setAvailable(java.lang.String available)

getIcon

  1. public java.lang.String getIcon( )

setIcon

  1. public void setIcon(java.lang.String icon)

getLabel

  1. public java.lang.String getLabel( )

setLabel

  1. public void setLabel(java.lang.String label)

getDescription

  1. public java.lang.String getDescription( )

setDescription

  1. public void setDescription(java.lang.String description)

getUrl

  1. public java.lang.String getUrl( )

setUrl

  1. public void setUrl(java.lang.String url)

getDesktopId

  1. public java.lang.String getDesktopId( )

setDesktopId

  1. public void setDesktopId(java.lang.String desktopId)

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