com.ibm.ecm.configuration

Class SyncItemConfig

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

com.ibm.ecm.configuration.SyncItemConfig

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class SyncItemConfig
extends ConfigurationObject
implements java.io.Serializable, java.lang.Comparable

Since:

2.0.3.6

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object other)
void	copyFromFavorite(FavoriteConfig favorite)
static SyncItemConfig	createFromFavorite(ConfigInterface configInterface, FavoriteConfig favorite, java.lang.String appName)
static SyncItemConfig	createFromFavorite(FavoriteConfig favorite, java.lang.String appName) Deprecated. see createFromFavorite(ConfigInterface, FavoriteConfig, String);
static java.lang.String	createSyncItemIdFromFavoriteId(java.lang.String favoriteId)
static java.lang.String	createUserConfigIdFromSyncId(java.lang.String syncItemId)
java.lang.String	getAlias()
protected java.lang.Class	getDataType(java.lang.String key) Returns the datatype of a configuration property.
boolean	getHasContentFlag()
java.lang.String	getItemId()
java.lang.String	getMimeType()
java.lang.String	getObjectType() Abstract method to return object type.
java.lang.String	getRepositoryId()
java.lang.String	getRepositoryLabel()
java.lang.String	getSubType()
java.lang.String	getSyncDevices()
long	getSyncId()
long	getSyncRepositoryId()
java.lang.String	getTemplate()
java.lang.String	getType()
java.lang.String	getVersionSerieId()
boolean	isHidden()
void	load() Initializes the superclass default property values map.
void	setAlias(java.lang.String alias)
void	setHasContentFlag(boolean hasContentFlag)
void	setHidden(boolean hidden)
void	setItemId(java.lang.String itemId)
void	setMimeType(java.lang.String mimetype)
void	setRepositoryId(java.lang.String id)
void	setRepositoryLabel(java.lang.String label)
void	setSubType(java.lang.String subType)
void	setSyncDevices(java.lang.String syncDevices)
void	setSyncId(long syncId)
void	setSyncRepositoryId(long syncRepositoryId)
void	setTemplate(java.lang.String template)
void	setType(java.lang.String type)
void	setVersionSerieId(java.lang.String vsId)
com.ibm.json.java.JSONObject	toJSON() Override parent class implementation.

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, 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

SyncItemConfig

public SyncItemConfig(org.apache.commons.configuration.Configuration configuration,
                      java.lang.String idPrefix,
                      java.lang.String objectId)

Method Detail

load

public void load()

Initializes the superclass default property values map.

Overrides:

load in class ConfigurationObject

Since:

2.0.3.8

createSyncItemIdFromFavoriteId

public static java.lang.String createSyncItemIdFromFavoriteId(java.lang.String favoriteId)

createUserConfigIdFromSyncId

public static java.lang.String createUserConfigIdFromSyncId(java.lang.String syncItemId)

createFromFavorite

public static SyncItemConfig createFromFavorite(FavoriteConfig favorite,
                                                java.lang.String appName)
                                         throws org.apache.commons.configuration.ConfigurationException,
                                                MissingValueException

Deprecated. see createFromFavorite(ConfigInterface, FavoriteConfig, String);

Parameters:

favorite -

appName -

Returns:

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

createFromFavorite

public static SyncItemConfig createFromFavorite(ConfigInterface configInterface,
                                                FavoriteConfig favorite,
                                                java.lang.String appName)
                                         throws org.apache.commons.configuration.ConfigurationException,
                                                MissingValueException

Parameters:

configInterface -

favorite -

appName -

Returns:

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

ICN 2.0.3.6

copyFromFavorite

public void copyFromFavorite(FavoriteConfig favorite)

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.

getRepositoryId

public java.lang.String getRepositoryId()

setRepositoryId

public void setRepositoryId(java.lang.String id)

getRepositoryLabel

public java.lang.String getRepositoryLabel()

setRepositoryLabel

public void setRepositoryLabel(java.lang.String label)

getAlias

public java.lang.String getAlias()

setAlias

public void setAlias(java.lang.String alias)

getItemId

public java.lang.String getItemId()

setItemId

public void setItemId(java.lang.String itemId)

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

compareTo

public int compareTo(java.lang.Object other)

Specified by:

compareTo in interface java.lang.Comparable

setTemplate

public void setTemplate(java.lang.String template)

getTemplate

public java.lang.String getTemplate()

setMimeType

public void setMimeType(java.lang.String mimetype)

getMimeType

public java.lang.String getMimeType()

setVersionSerieId

public void setVersionSerieId(java.lang.String vsId)

getVersionSerieId

public java.lang.String getVersionSerieId()

getHasContentFlag

public boolean getHasContentFlag()

setHasContentFlag

public void setHasContentFlag(boolean hasContentFlag)

getSyncId

public long getSyncId()

setSyncId

public void setSyncId(long syncId)

getSyncDevices

public java.lang.String getSyncDevices()

setSyncDevices

public void setSyncDevices(java.lang.String syncDevices)

getSyncRepositoryId

public long getSyncRepositoryId()

setSyncRepositoryId

public void setSyncRepositoryId(long syncRepositoryId)

setHidden

public void setHidden(boolean hidden)

isHidden

public boolean isHidden()

setSubType

public void setSubType(java.lang.String subType)

getSubType

public java.lang.String getSubType()

toJSON

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

Override parent class implementation.

Overrides:

toJSON in class ConfigurationObject

Returns:

A JSONObject of this configuration