com.liferay.portlet.dynamicdatamapping.model.impl
Class DDMStructureModelImpl

java.lang.Object
  com.liferay.portal.model.impl.BaseModelImpl<DDMStructure>
      com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl

All Implemented Interfaces:

AuditedModel, BaseModel<DDMStructure>, ClassedModel, GroupedModel, StagedGroupedModel, StagedModel, TypedModel, DDMStructureModel, Serializable, Cloneable, Comparable<DDMStructure>

Direct Known Subclasses:

DDMStructureBaseImpl

@JSON(strict=true)
public class DDMStructureModelImpl
extends BaseModelImpl<DDMStructure>
implements DDMStructureModel

The base model implementation for the DDMStructure service. Represents a row in the "DDMStructure" database table, with each column mapped to a property of this class.

This implementation and its corresponding interface DDMStructureModel exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in DDMStructureImpl.

See Also:

DDMStructureImpl, DDMStructure, DDMStructureModel, Serialized Form

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Field Summary

static long	CLASSNAMEID_COLUMN_BITMASK
static boolean	COLUMN_BITMASK_ENABLED
static long	COMPANYID_COLUMN_BITMASK
static String	DATA_SOURCE
static long	DESCRIPTION_COLUMN_BITMASK
static boolean	ENTITY_CACHE_ENABLED
static boolean	FINDER_CACHE_ENABLED
static boolean	FINDER_CACHE_ENABLED_DLFILEENTRYTYPES_DDMSTRUCTURES
static long	GROUPID_COLUMN_BITMASK
static long	LOCK_EXPIRATION_TIME
static Object[][]	MAPPING_TABLE_DLFILEENTRYTYPES_DDMSTRUCTURES_COLUMNS
static String	MAPPING_TABLE_DLFILEENTRYTYPES_DDMSTRUCTURES_NAME
static String	MAPPING_TABLE_DLFILEENTRYTYPES_DDMSTRUCTURES_SQL_CREATE
static long	NAME_COLUMN_BITMASK
static String	ORDER_BY_JPQL
static String	ORDER_BY_SQL
static long	PARENTSTRUCTUREID_COLUMN_BITMASK
static String	SESSION_FACTORY
static long	STRUCTUREID_COLUMN_BITMASK
static long	STRUCTUREKEY_COLUMN_BITMASK
static Object[][]	TABLE_COLUMNS
static String	TABLE_NAME
static String	TABLE_SQL_CREATE
static String	TABLE_SQL_DROP
static String	TX_MANAGER
static long	UUID_COLUMN_BITMASK

Constructor Summary

DDMStructureModelImpl()

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(DDMStructure ddmStructure)
boolean	equals(Object obj)
String[]	getAvailableLanguageIds()
String	getClassName() Returns the fully qualified class name of this d d m structure.
long	getClassNameId() Returns the class name ID of this d d m structure.
long	getColumnBitmask()
long	getCompanyId() Returns the company ID of this d d m structure.
Date	getCreateDate() Returns the create date of this d d m structure.
String	getDefaultLanguageId()
String	getDescription() Returns the description of this d d m structure.
String	getDescription(Locale locale) Returns the localized description of this d d m structure in the language.
String	getDescription(Locale locale, boolean useDefault) Returns the localized description of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.
String	getDescription(String languageId) Returns the localized description of this d d m structure in the language.
String	getDescription(String languageId, boolean useDefault) Returns the localized description of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.
String	getDescriptionCurrentLanguageId()
String	getDescriptionCurrentValue()
Map<Locale,String>	getDescriptionMap() Returns a map of the locales and localized descriptions of this d d m structure.
Document	getDocument()
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getGroupId() Returns the group ID of this d d m structure.
Map<String,Map<String,Map<String,String>>>	getLocalizedFieldsMap()
Map<String,Map<String,Map<String,String>>>	getLocalizedPersistentFieldsMap()
Map<String,Map<String,Map<String,String>>>	getLocalizedTransientFieldsMap()
Map<String,Object>	getModelAttributes()
Class<?>	getModelClass()
String	getModelClassName()
Date	getModifiedDate() Returns the modified date of this d d m structure.
String	getName() Returns the name of this d d m structure.
String	getName(Locale locale) Returns the localized name of this d d m structure in the language.
String	getName(Locale locale, boolean useDefault) Returns the localized name of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.
String	getName(String languageId) Returns the localized name of this d d m structure in the language.
String	getName(String languageId, boolean useDefault) Returns the localized name of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.
String	getNameCurrentLanguageId()
String	getNameCurrentValue()
Map<Locale,String>	getNameMap() Returns a map of the locales and localized names of this d d m structure.
long	getOriginalClassNameId()
long	getOriginalCompanyId()
String	getOriginalDescription()
long	getOriginalGroupId()
String	getOriginalName()
long	getOriginalParentStructureId()
String	getOriginalStructureKey()
String	getOriginalUuid()
long	getParentStructureId() Returns the parent structure ID of this d d m structure.
long	getPrimaryKey() Returns the primary key of this d d m structure.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
StagedModelType	getStagedModelType()
String	getStorageType() Returns the storage type of this d d m structure.
long	getStructureId() Returns the structure ID of this d d m structure.
String	getStructureKey() Returns the structure key of this d d m structure.
int	getType() Returns the type of this d d m structure.
long	getUserId() Returns the user ID of this d d m structure.
String	getUserName() Returns the user name of this d d m structure.
String	getUserUuid() Returns the user uuid of this d d m structure.
String	getUuid() Returns the uuid of this d d m structure.
String	getXsd() Returns the xsd of this d d m structure.
int	hashCode()
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(Locale defaultImportLocale)
void	resetOriginalValues() Reset all original fields to current values.
void	setClassName(String className)
void	setClassNameId(long classNameId) Sets the class name ID of this d d m structure.
void	setCompanyId(long companyId) Sets the company ID of this d d m structure.
void	setCreateDate(Date createDate) Sets the create date of this d d m structure.
void	setDescription(String description) Sets the description of this d d m structure.
void	setDescription(String description, Locale locale) Sets the localized description of this d d m structure in the language.
void	setDescription(String description, Locale locale, Locale defaultLocale) Sets the localized description of this d d m structure in the language, and sets the default locale.
void	setDescriptionCurrentLanguageId(String languageId)
void	setDescriptionMap(Map<Locale,String> descriptionMap) Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions.
void	setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions, and sets the default locale.
void	setDocument(Document document)
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setGroupId(long groupId) Sets the group ID of this d d m structure.
void	setLocalizedFieldsMap(Map<String,Map<String,Map<String,String>>> localizedFieldsMap)
void	setLocalizedPersistentFieldsMap(Map<String,Map<String,Map<String,String>>> localizedPersistentFieldsMap)
void	setLocalizedTransientFieldsMap(Map<String,Map<String,Map<String,String>>> localizedTransientFieldsMap)
void	setModelAttributes(Map<String,Object> attributes)
void	setModifiedDate(Date modifiedDate) Sets the modified date of this d d m structure.
void	setName(String name) Sets the name of this d d m structure.
void	setName(String name, Locale locale) Sets the localized name of this d d m structure in the language.
void	setName(String name, Locale locale, Locale defaultLocale) Sets the localized name of this d d m structure in the language, and sets the default locale.
void	setNameCurrentLanguageId(String languageId)
void	setNameMap(Map<Locale,String> nameMap) Sets the localized names of this d d m structure from the map of locales and localized names.
void	setNameMap(Map<Locale,String> nameMap, Locale defaultLocale) Sets the localized names of this d d m structure from the map of locales and localized names, and sets the default locale.
void	setParentStructureId(long parentStructureId) Sets the parent structure ID of this d d m structure.
void	setPrimaryKey(long primaryKey) Sets the primary key of this d d m structure.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setStorageType(String storageType) Sets the storage type of this d d m structure.
void	setStructureId(long structureId) Sets the structure ID of this d d m structure.
void	setStructureKey(String structureKey) Sets the structure key of this d d m structure.
void	setType(int type) Sets the type of this d d m structure.
void	setUserId(long userId) Sets the user ID of this d d m structure.
void	setUserName(String userName) Sets the user name of this d d m structure.
void	setUserUuid(String userUuid) Sets the user uuid of this d d m structure.
void	setUuid(String uuid) Sets the uuid of this d d m structure.
void	setXsd(String xsd) Sets the xsd of this d d m structure.
CacheModel<DDMStructure>	toCacheModel() Returns a cache model object for this entity used by entity cache.
DDMStructure	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
static DDMStructure	toModel(DDMStructureSoap soapModel) Converts the soap model instance into a normal model instance.
static List<DDMStructure>	toModels(DDMStructureSoap[] soapModels) Converts the soap model instances into normal model instances.
String	toString()
String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from class com.liferay.portal.model.impl.BaseModelImpl

getLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, toUnescapedModel

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.liferay.portlet.dynamicdatamapping.model.DDMStructureModel

isCachedModel, isEscapedModel, isNew, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, toUnescapedModel

Field Detail

TABLE_NAME

public static final String TABLE_NAME

See Also:

Constant Field Values

TABLE_COLUMNS

public static final Object[][] TABLE_COLUMNS

TABLE_SQL_CREATE

public static final String TABLE_SQL_CREATE

See Also:

Constant Field Values

TABLE_SQL_DROP

public static final String TABLE_SQL_DROP

See Also:

Constant Field Values

ORDER_BY_JPQL

public static final String ORDER_BY_JPQL

See Also:

Constant Field Values

ORDER_BY_SQL

public static final String ORDER_BY_SQL

See Also:

Constant Field Values

DATA_SOURCE

public static final String DATA_SOURCE

See Also:

Constant Field Values

SESSION_FACTORY

public static final String SESSION_FACTORY

See Also:

Constant Field Values

TX_MANAGER

public static final String TX_MANAGER

See Also:

Constant Field Values

ENTITY_CACHE_ENABLED

public static final boolean ENTITY_CACHE_ENABLED

FINDER_CACHE_ENABLED

public static final boolean FINDER_CACHE_ENABLED

COLUMN_BITMASK_ENABLED

public static final boolean COLUMN_BITMASK_ENABLED

CLASSNAMEID_COLUMN_BITMASK

public static long CLASSNAMEID_COLUMN_BITMASK

COMPANYID_COLUMN_BITMASK

public static long COMPANYID_COLUMN_BITMASK

DESCRIPTION_COLUMN_BITMASK

public static long DESCRIPTION_COLUMN_BITMASK

GROUPID_COLUMN_BITMASK

public static long GROUPID_COLUMN_BITMASK

NAME_COLUMN_BITMASK

public static long NAME_COLUMN_BITMASK

PARENTSTRUCTUREID_COLUMN_BITMASK

public static long PARENTSTRUCTUREID_COLUMN_BITMASK

STRUCTUREKEY_COLUMN_BITMASK

public static long STRUCTUREKEY_COLUMN_BITMASK

UUID_COLUMN_BITMASK

public static long UUID_COLUMN_BITMASK

STRUCTUREID_COLUMN_BITMASK

public static long STRUCTUREID_COLUMN_BITMASK

MAPPING_TABLE_DLFILEENTRYTYPES_DDMSTRUCTURES_NAME

public static final String MAPPING_TABLE_DLFILEENTRYTYPES_DDMSTRUCTURES_NAME

See Also:

Constant Field Values

MAPPING_TABLE_DLFILEENTRYTYPES_DDMSTRUCTURES_COLUMNS

public static final Object[][] MAPPING_TABLE_DLFILEENTRYTYPES_DDMSTRUCTURES_COLUMNS

MAPPING_TABLE_DLFILEENTRYTYPES_DDMSTRUCTURES_SQL_CREATE

public static final String MAPPING_TABLE_DLFILEENTRYTYPES_DDMSTRUCTURES_SQL_CREATE

See Also:

Constant Field Values

FINDER_CACHE_ENABLED_DLFILEENTRYTYPES_DDMSTRUCTURES

public static final boolean FINDER_CACHE_ENABLED_DLFILEENTRYTYPES_DDMSTRUCTURES

LOCK_EXPIRATION_TIME

public static final long LOCK_EXPIRATION_TIME

Constructor Detail

DDMStructureModelImpl

public DDMStructureModelImpl()

Method Detail

toModel

public static DDMStructure toModel(DDMStructureSoap soapModel)

Converts the soap model instance into a normal model instance.

Parameters:

soapModel - the soap model instance to convert

Returns:

the normal model instance

toModels

public static List<DDMStructure> toModels(DDMStructureSoap[] soapModels)

Converts the soap model instances into normal model instances.

Parameters:

soapModels - the soap model instances to convert

Returns:

the normal model instances

getPrimaryKey

public long getPrimaryKey()

Description copied from interface: DDMStructureModel

Returns the primary key of this d d m structure.

Specified by:

getPrimaryKey in interface DDMStructureModel

Returns:

the primary key of this d d m structure

setPrimaryKey

public void setPrimaryKey(long primaryKey)

Description copied from interface: DDMStructureModel

Sets the primary key of this d d m structure.

Specified by:

setPrimaryKey in interface DDMStructureModel

Parameters:

primaryKey - the primary key of this d d m structure

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<DDMStructure>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Specified by:

getPrimaryKeyObj in interface DDMStructureModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

public void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<DDMStructure>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Specified by:

setPrimaryKeyObj in interface DDMStructureModel

Parameters:

primaryKeyObj - the primary key of this model instance

getModelClass

public Class<?> getModelClass()

Specified by:

getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()

Specified by:

getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()

Specified by:

getModelAttributes in interface BaseModel<DDMStructure>

Overrides:

getModelAttributes in class BaseModelImpl<DDMStructure>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)

Specified by:

setModelAttributes in interface BaseModel<DDMStructure>

Overrides:

setModelAttributes in class BaseModelImpl<DDMStructure>

getUuid

@JSON
public String getUuid()

Description copied from interface: DDMStructureModel

Returns the uuid of this d d m structure.

Specified by:

getUuid in interface StagedModel

Specified by:

getUuid in interface DDMStructureModel

Returns:

the uuid of this d d m structure

setUuid

public void setUuid(String uuid)

Description copied from interface: DDMStructureModel

Sets the uuid of this d d m structure.

Specified by:

setUuid in interface StagedModel

Specified by:

setUuid in interface DDMStructureModel

Parameters:

uuid - the uuid of this d d m structure

getOriginalUuid

public String getOriginalUuid()

getStructureId

@JSON
public long getStructureId()

Description copied from interface: DDMStructureModel

Returns the structure ID of this d d m structure.

Specified by:

getStructureId in interface DDMStructureModel

Returns:

the structure ID of this d d m structure

setStructureId

public void setStructureId(long structureId)

Description copied from interface: DDMStructureModel

Sets the structure ID of this d d m structure.

Specified by:

setStructureId in interface DDMStructureModel

Parameters:

structureId - the structure ID of this d d m structure

getGroupId

@JSON
public long getGroupId()

Description copied from interface: DDMStructureModel

Returns the group ID of this d d m structure.

Specified by:

getGroupId in interface GroupedModel

Specified by:

getGroupId in interface DDMStructureModel

Returns:

the group ID of this d d m structure

setGroupId

public void setGroupId(long groupId)

Description copied from interface: DDMStructureModel

Sets the group ID of this d d m structure.

Specified by:

setGroupId in interface GroupedModel

Specified by:

setGroupId in interface DDMStructureModel

Parameters:

groupId - the group ID of this d d m structure

getOriginalGroupId

public long getOriginalGroupId()

getCompanyId

@JSON
public long getCompanyId()

Description copied from interface: DDMStructureModel

Returns the company ID of this d d m structure.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface StagedModel

Specified by:

getCompanyId in interface DDMStructureModel

Returns:

the company ID of this d d m structure

setCompanyId

public void setCompanyId(long companyId)

Description copied from interface: DDMStructureModel

Sets the company ID of this d d m structure.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface StagedModel

Specified by:

setCompanyId in interface DDMStructureModel

Parameters:

companyId - the company ID of this d d m structure

getOriginalCompanyId

public long getOriginalCompanyId()

getUserId

@JSON
public long getUserId()

Description copied from interface: DDMStructureModel

Returns the user ID of this d d m structure.

Specified by:

getUserId in interface AuditedModel

Specified by:

getUserId in interface DDMStructureModel

Returns:

the user ID of this d d m structure

setUserId

public void setUserId(long userId)

Description copied from interface: DDMStructureModel

Sets the user ID of this d d m structure.

Specified by:

setUserId in interface AuditedModel

Specified by:

setUserId in interface DDMStructureModel

Parameters:

userId - the user ID of this d d m structure

getUserUuid

public String getUserUuid()
                   throws SystemException

Description copied from interface: DDMStructureModel

Returns the user uuid of this d d m structure.

Specified by:

getUserUuid in interface AuditedModel

Specified by:

getUserUuid in interface DDMStructureModel

Returns:

the user uuid of this d d m structure

Throws:

SystemException - if a system exception occurred

setUserUuid

public void setUserUuid(String userUuid)

Description copied from interface: DDMStructureModel

Sets the user uuid of this d d m structure.

Specified by:

setUserUuid in interface AuditedModel

Specified by:

setUserUuid in interface DDMStructureModel

Parameters:

userUuid - the user uuid of this d d m structure

getUserName

@JSON
public String getUserName()

Description copied from interface: DDMStructureModel

Returns the user name of this d d m structure.

Specified by:

getUserName in interface AuditedModel

Specified by:

getUserName in interface DDMStructureModel

Returns:

the user name of this d d m structure

setUserName

public void setUserName(String userName)

Description copied from interface: DDMStructureModel

Sets the user name of this d d m structure.

Specified by:

setUserName in interface AuditedModel

Specified by:

setUserName in interface DDMStructureModel

Parameters:

userName - the user name of this d d m structure

getCreateDate

@JSON
public Date getCreateDate()

Description copied from interface: DDMStructureModel

Returns the create date of this d d m structure.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Specified by:

getCreateDate in interface DDMStructureModel

Returns:

the create date of this d d m structure

setCreateDate

public void setCreateDate(Date createDate)

Description copied from interface: DDMStructureModel

Sets the create date of this d d m structure.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Specified by:

setCreateDate in interface DDMStructureModel

Parameters:

createDate - the create date of this d d m structure

getModifiedDate

@JSON
public Date getModifiedDate()

Description copied from interface: DDMStructureModel

Returns the modified date of this d d m structure.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Specified by:

getModifiedDate in interface DDMStructureModel

Returns:

the modified date of this d d m structure

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Description copied from interface: DDMStructureModel

Sets the modified date of this d d m structure.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Specified by:

setModifiedDate in interface DDMStructureModel

Parameters:

modifiedDate - the modified date of this d d m structure

getParentStructureId

@JSON
public long getParentStructureId()

Description copied from interface: DDMStructureModel

Returns the parent structure ID of this d d m structure.

Specified by:

getParentStructureId in interface DDMStructureModel

Returns:

the parent structure ID of this d d m structure

setParentStructureId

public void setParentStructureId(long parentStructureId)

Description copied from interface: DDMStructureModel

Sets the parent structure ID of this d d m structure.

Specified by:

setParentStructureId in interface DDMStructureModel

Parameters:

parentStructureId - the parent structure ID of this d d m structure

getOriginalParentStructureId

public long getOriginalParentStructureId()

getClassName

public String getClassName()

Description copied from interface: DDMStructureModel

Returns the fully qualified class name of this d d m structure.

Specified by:

getClassName in interface TypedModel

Specified by:

getClassName in interface DDMStructureModel

Returns:

the fully qualified class name of this d d m structure

setClassName

public void setClassName(String className)

Specified by:

setClassName in interface DDMStructureModel

getClassNameId

@JSON
public long getClassNameId()

Description copied from interface: DDMStructureModel

Returns the class name ID of this d d m structure.

Specified by:

getClassNameId in interface TypedModel

Specified by:

getClassNameId in interface DDMStructureModel

Returns:

the class name ID of this d d m structure

setClassNameId

public void setClassNameId(long classNameId)

Description copied from interface: DDMStructureModel

Sets the class name ID of this d d m structure.

Specified by:

setClassNameId in interface TypedModel

Specified by:

setClassNameId in interface DDMStructureModel

Parameters:

classNameId - the class name ID of this d d m structure

getOriginalClassNameId

public long getOriginalClassNameId()

getStructureKey

@JSON
public String getStructureKey()

Description copied from interface: DDMStructureModel

Returns the structure key of this d d m structure.

Specified by:

getStructureKey in interface DDMStructureModel

Returns:

the structure key of this d d m structure

setStructureKey

public void setStructureKey(String structureKey)

Description copied from interface: DDMStructureModel

Sets the structure key of this d d m structure.

Specified by:

setStructureKey in interface DDMStructureModel

Parameters:

structureKey - the structure key of this d d m structure

getOriginalStructureKey

public String getOriginalStructureKey()

getName

@JSON
public String getName()

Description copied from interface: DDMStructureModel

Returns the name of this d d m structure.

Specified by:

getName in interface DDMStructureModel

Returns:

the name of this d d m structure

getName

public String getName(Locale locale)

Description copied from interface: DDMStructureModel

Returns the localized name of this d d m structure in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getName in interface DDMStructureModel

Parameters:

locale - the locale of the language

Returns:

the localized name of this d d m structure

getName

public String getName(Locale locale,
                      boolean useDefault)

Description copied from interface: DDMStructureModel

Returns the localized name of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.

Specified by:

getName in interface DDMStructureModel

Parameters:

locale - the local of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized name of this d d m structure. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

public String getName(String languageId)

Description copied from interface: DDMStructureModel

Returns the localized name of this d d m structure in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getName in interface DDMStructureModel

Parameters:

languageId - the ID of the language

Returns:

the localized name of this d d m structure

getName

public String getName(String languageId,
                      boolean useDefault)

Description copied from interface: DDMStructureModel

Returns the localized name of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.

Specified by:

getName in interface DDMStructureModel

Parameters:

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized name of this d d m structure

getNameCurrentLanguageId

public String getNameCurrentLanguageId()

Specified by:

getNameCurrentLanguageId in interface DDMStructureModel

getNameCurrentValue

@JSON
public String getNameCurrentValue()

Specified by:

getNameCurrentValue in interface DDMStructureModel

getNameMap

public Map<Locale,String> getNameMap()

Description copied from interface: DDMStructureModel

Returns a map of the locales and localized names of this d d m structure.

Specified by:

getNameMap in interface DDMStructureModel

Returns:

the locales and localized names of this d d m structure

setName

public void setName(String name)

Description copied from interface: DDMStructureModel

Sets the name of this d d m structure.

Specified by:

setName in interface DDMStructureModel

Parameters:

name - the name of this d d m structure

setName

public void setName(String name,
                    Locale locale)

Description copied from interface: DDMStructureModel

Sets the localized name of this d d m structure in the language.

Specified by:

setName in interface DDMStructureModel

Parameters:

name - the localized name of this d d m structure

locale - the locale of the language

setName

public void setName(String name,
                    Locale locale,
                    Locale defaultLocale)

Description copied from interface: DDMStructureModel

Sets the localized name of this d d m structure in the language, and sets the default locale.

Specified by:

setName in interface DDMStructureModel

Parameters:

name - the localized name of this d d m structure

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

public void setNameCurrentLanguageId(String languageId)

Specified by:

setNameCurrentLanguageId in interface DDMStructureModel

setNameMap

public void setNameMap(Map<Locale,String> nameMap)

Description copied from interface: DDMStructureModel

Sets the localized names of this d d m structure from the map of locales and localized names.

Specified by:

setNameMap in interface DDMStructureModel

Parameters:

nameMap - the locales and localized names of this d d m structure

setNameMap

public void setNameMap(Map<Locale,String> nameMap,
                       Locale defaultLocale)

Description copied from interface: DDMStructureModel

Sets the localized names of this d d m structure from the map of locales and localized names, and sets the default locale.

Specified by:

setNameMap in interface DDMStructureModel

Parameters:

nameMap - the locales and localized names of this d d m structure

defaultLocale - the default locale

getOriginalName

public String getOriginalName()

getDescription

@JSON
public String getDescription()

Description copied from interface: DDMStructureModel

Returns the description of this d d m structure.

Specified by:

getDescription in interface DDMStructureModel

Returns:

the description of this d d m structure

getDescription

public String getDescription(Locale locale)

Description copied from interface: DDMStructureModel

Returns the localized description of this d d m structure in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getDescription in interface DDMStructureModel

Parameters:

locale - the locale of the language

Returns:

the localized description of this d d m structure

getDescription

public String getDescription(Locale locale,
                             boolean useDefault)

Description copied from interface: DDMStructureModel

Returns the localized description of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.

Specified by:

getDescription in interface DDMStructureModel

Parameters:

locale - the local of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized description of this d d m structure. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

public String getDescription(String languageId)

Description copied from interface: DDMStructureModel

Returns the localized description of this d d m structure in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getDescription in interface DDMStructureModel

Parameters:

languageId - the ID of the language

Returns:

the localized description of this d d m structure

getDescription

public String getDescription(String languageId,
                             boolean useDefault)

Description copied from interface: DDMStructureModel

Returns the localized description of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.

Specified by:

getDescription in interface DDMStructureModel

Parameters:

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized description of this d d m structure

getDescriptionCurrentLanguageId

public String getDescriptionCurrentLanguageId()

Specified by:

getDescriptionCurrentLanguageId in interface DDMStructureModel

getDescriptionCurrentValue

@JSON
public String getDescriptionCurrentValue()

Specified by:

getDescriptionCurrentValue in interface DDMStructureModel

getDescriptionMap

public Map<Locale,String> getDescriptionMap()

Description copied from interface: DDMStructureModel

Returns a map of the locales and localized descriptions of this d d m structure.

Specified by:

getDescriptionMap in interface DDMStructureModel

Returns:

the locales and localized descriptions of this d d m structure

setDescription

public void setDescription(String description)

Description copied from interface: DDMStructureModel

Sets the description of this d d m structure.

Specified by:

setDescription in interface DDMStructureModel

Parameters:

description - the description of this d d m structure

setDescription

public void setDescription(String description,
                           Locale locale)

Description copied from interface: DDMStructureModel

Sets the localized description of this d d m structure in the language.

Specified by:

setDescription in interface DDMStructureModel

Parameters:

description - the localized description of this d d m structure

locale - the locale of the language

setDescription

public void setDescription(String description,
                           Locale locale,
                           Locale defaultLocale)

Description copied from interface: DDMStructureModel

Sets the localized description of this d d m structure in the language, and sets the default locale.

Specified by:

setDescription in interface DDMStructureModel

Parameters:

description - the localized description of this d d m structure

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

public void setDescriptionCurrentLanguageId(String languageId)

Specified by:

setDescriptionCurrentLanguageId in interface DDMStructureModel

setDescriptionMap

public void setDescriptionMap(Map<Locale,String> descriptionMap)

Description copied from interface: DDMStructureModel

Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions.

Specified by:

setDescriptionMap in interface DDMStructureModel

Parameters:

descriptionMap - the locales and localized descriptions of this d d m structure

setDescriptionMap

public void setDescriptionMap(Map<Locale,String> descriptionMap,
                              Locale defaultLocale)

Description copied from interface: DDMStructureModel

Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions, and sets the default locale.

Specified by:

setDescriptionMap in interface DDMStructureModel

Parameters:

descriptionMap - the locales and localized descriptions of this d d m structure

defaultLocale - the default locale

getOriginalDescription

public String getOriginalDescription()

getXsd

@JSON
public String getXsd()

Description copied from interface: DDMStructureModel

Returns the xsd of this d d m structure.

Specified by:

getXsd in interface DDMStructureModel

Returns:

the xsd of this d d m structure

setXsd

public void setXsd(String xsd)

Description copied from interface: DDMStructureModel

Sets the xsd of this d d m structure.

Specified by:

setXsd in interface DDMStructureModel

Parameters:

xsd - the xsd of this d d m structure

getStorageType

@JSON
public String getStorageType()

Description copied from interface: DDMStructureModel

Returns the storage type of this d d m structure.

Specified by:

getStorageType in interface DDMStructureModel

Returns:

the storage type of this d d m structure

setStorageType

public void setStorageType(String storageType)

Description copied from interface: DDMStructureModel

Sets the storage type of this d d m structure.

Specified by:

setStorageType in interface DDMStructureModel

Parameters:

storageType - the storage type of this d d m structure

getType

@JSON
public int getType()

Description copied from interface: DDMStructureModel

Returns the type of this d d m structure.

Specified by:

getType in interface DDMStructureModel

Returns:

the type of this d d m structure

setType

public void setType(int type)

Description copied from interface: DDMStructureModel

Sets the type of this d d m structure.

Specified by:

setType in interface DDMStructureModel

Parameters:

type - the type of this d d m structure

getDocument

public Document getDocument()

setDocument

public void setDocument(Document document)

getLocalizedFieldsMap

public Map<String,Map<String,Map<String,String>>> getLocalizedFieldsMap()

setLocalizedFieldsMap

public void setLocalizedFieldsMap(Map<String,Map<String,Map<String,String>>> localizedFieldsMap)

getLocalizedPersistentFieldsMap

public Map<String,Map<String,Map<String,String>>> getLocalizedPersistentFieldsMap()

setLocalizedPersistentFieldsMap

public void setLocalizedPersistentFieldsMap(Map<String,Map<String,Map<String,String>>> localizedPersistentFieldsMap)

getLocalizedTransientFieldsMap

public Map<String,Map<String,Map<String,String>>> getLocalizedTransientFieldsMap()

setLocalizedTransientFieldsMap

public void setLocalizedTransientFieldsMap(Map<String,Map<String,Map<String,String>>> localizedTransientFieldsMap)

getStagedModelType

public StagedModelType getStagedModelType()

Specified by:

getStagedModelType in interface StagedModel

getColumnBitmask

public long getColumnBitmask()

getExpandoBridge

public ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<DDMStructure>

Specified by:

getExpandoBridge in interface ClassedModel

Specified by:

getExpandoBridge in interface DDMStructureModel

Overrides:

getExpandoBridge in class BaseModelImpl<DDMStructure>

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ServiceContext serviceContext)

Description copied from interface: BaseModel

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DDMStructure>

Specified by:

setExpandoBridgeAttributes in interface DDMStructureModel

Overrides:

setExpandoBridgeAttributes in class BaseModelImpl<DDMStructure>

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes( )

getAvailableLanguageIds

public String[] getAvailableLanguageIds()

Specified by:

getAvailableLanguageIds in interface DDMStructureModel

getDefaultLanguageId

public String getDefaultLanguageId()

Specified by:

getDefaultLanguageId in interface DDMStructureModel

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport()
                                     throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface DDMStructureModel

Throws:

LocaleException

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface DDMStructureModel

Throws:

LocaleException

toEscapedModel

public DDMStructure toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<DDMStructure>

Specified by:

toEscapedModel in interface DDMStructureModel

Overrides:

toEscapedModel in class BaseModelImpl<DDMStructure>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

clone

public Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<DDMStructure>

Specified by:

clone in interface StagedModel

Specified by:

clone in interface DDMStructureModel

Specified by:

clone in class BaseModelImpl<DDMStructure>

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(DDMStructure ddmStructure)

Specified by:

compareTo in interface DDMStructureModel

Specified by:

compareTo in interface Comparable<DDMStructure>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface DDMStructureModel

Overrides:

hashCode in class Object

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<DDMStructure>

Overrides:

resetOriginalValues in class BaseModelImpl<DDMStructure>

toCacheModel

public CacheModel<DDMStructure> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<DDMStructure>

Specified by:

toCacheModel in interface DDMStructureModel

Overrides:

toCacheModel in class BaseModelImpl<DDMStructure>

Returns:

the cache model object

toString

public String toString()

Specified by:

toString in interface DDMStructureModel

Overrides:

toString in class Object

toXmlString

public String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<DDMStructure>

Specified by:

toXmlString in interface DDMStructureModel

Returns:

the XML representation of this model instance