com.liferay.portlet.dynamicdatamapping.model
Interface DDMStructureModel

All Superinterfaces:

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

All Known Subinterfaces:

DDMStructure

All Known Implementing Classes:

DDMStructureBaseImpl, DDMStructureImpl, DDMStructureModelImpl, DDMStructureWrapper

@ProviderType
public interface DDMStructureModel
extends BaseModel<DDMStructure>, StagedGroupedModel, TypedModel

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

This interface and its corresponding implementation DDMStructureModelImpl 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:

DDMStructure, DDMStructureImpl, DDMStructureModelImpl

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

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(DDMStructure ddmStructure)
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	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.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getGroupId() Returns the group ID of this d d m structure.
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	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.
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()
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(Locale defaultImportLocale)
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
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	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
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	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	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
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.
String	toString()
DDMStructure	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.model.BaseModel

getModelAttributes, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.model.StagedModel

getStagedModelType

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this d d m structure.

Returns:

the primary key of this d d m structure

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this d d m structure.

Parameters:

primaryKey - the primary key of this d d m structure

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this d d m structure.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this d d m structure

setUuid

void setUuid(String uuid)

Sets the uuid of this d d m structure.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this d d m structure

getStructureId

long getStructureId()

Returns the structure ID of this d d m structure.

Returns:

the structure ID of this d d m structure

setStructureId

void setStructureId(long structureId)

Sets the structure ID of this d d m structure.

Parameters:

structureId - the structure ID of this d d m structure

getGroupId

long getGroupId()

Returns the group ID of this d d m structure.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this d d m structure

setGroupId

void setGroupId(long groupId)

Sets the group ID of this d d m structure.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this d d m structure

getCompanyId

long getCompanyId()

Returns the company ID of this d d m structure.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface StagedModel

Returns:

the company ID of this d d m structure

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this d d m structure.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface StagedModel

Parameters:

companyId - the company ID of this d d m structure

getUserId

long getUserId()

Returns the user ID of this d d m structure.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this d d m structure

setUserId

void setUserId(long userId)

Sets the user ID of this d d m structure.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this d d m structure

getUserUuid

String getUserUuid()
                   throws SystemException

Returns the user uuid of this d d m structure.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this d d m structure

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this d d m structure.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this d d m structure

getUserName

@AutoEscape
String getUserName()

Returns the user name of this d d m structure.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this d d m structure

setUserName

void setUserName(String userName)

Sets the user name of this d d m structure.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this d d m structure

getCreateDate

Date getCreateDate()

Returns the create date of this d d m structure.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this d d m structure

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this d d m structure.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this d d m structure

getModifiedDate

Date getModifiedDate()

Returns the modified date of this d d m structure.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this d d m structure

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this d d m structure.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date of this d d m structure

getParentStructureId

long getParentStructureId()

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

Returns:

the parent structure ID of this d d m structure

setParentStructureId

void setParentStructureId(long parentStructureId)

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

Parameters:

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

getClassName

String getClassName()

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

Specified by:

getClassName in interface TypedModel

Returns:

the fully qualified class name of this d d m structure

setClassName

void setClassName(String className)

getClassNameId

long getClassNameId()

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

Specified by:

getClassNameId in interface TypedModel

Returns:

the class name ID of this d d m structure

setClassNameId

void setClassNameId(long classNameId)

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

Specified by:

setClassNameId in interface TypedModel

Parameters:

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

getStructureKey

String getStructureKey()

Returns the structure key of this d d m structure.

Returns:

the structure key of this d d m structure

setStructureKey

void setStructureKey(String structureKey)

Sets the structure key of this d d m structure.

Parameters:

structureKey - the structure key of this d d m structure

getName

String getName()

Returns the name of this d d m structure.

Returns:

the name of this d d m structure

getName

@AutoEscape
String getName(Locale locale)

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.

Parameters:

locale - the locale of the language

Returns:

the localized name of this d d m structure

getName

@AutoEscape
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.

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

@AutoEscape
String getName(String languageId)

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.

Parameters:

languageId - the ID of the language

Returns:

the localized name of this d d m structure

getName

@AutoEscape
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.

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

@AutoEscape
String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
String getNameCurrentValue()

getNameMap

Map<Locale,String> getNameMap()

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

Returns:

the locales and localized names of this d d m structure

setName

void setName(String name)

Sets the name of this d d m structure.

Parameters:

name - the name of this d d m structure

setName

void setName(String name,
             Locale locale)

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

Parameters:

name - the localized name of this d d m structure

locale - the locale of the language

setName

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.

Parameters:

name - the localized name of this d d m structure

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

void setNameCurrentLanguageId(String languageId)

setNameMap

void setNameMap(Map<Locale,String> nameMap)

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

Parameters:

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

setNameMap

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.

Parameters:

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

defaultLocale - the default locale

getDescription

String getDescription()

Returns the description of this d d m structure.

Returns:

the description of this d d m structure

getDescription

@AutoEscape
String getDescription(Locale locale)

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.

Parameters:

locale - the locale of the language

Returns:

the localized description of this d d m structure

getDescription

@AutoEscape
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.

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

@AutoEscape
String getDescription(String languageId)

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.

Parameters:

languageId - the ID of the language

Returns:

the localized description of this d d m structure

getDescription

@AutoEscape
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.

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

@AutoEscape
String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
String getDescriptionCurrentValue()

getDescriptionMap

Map<Locale,String> getDescriptionMap()

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

Returns:

the locales and localized descriptions of this d d m structure

setDescription

void setDescription(String description)

Sets the description of this d d m structure.

Parameters:

description - the description of this d d m structure

setDescription

void setDescription(String description,
                    Locale locale)

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

Parameters:

description - the localized description of this d d m structure

locale - the locale of the language

setDescription

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.

Parameters:

description - the localized description of this d d m structure

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(String languageId)

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap)

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

Parameters:

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

setDescriptionMap

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.

Parameters:

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

defaultLocale - the default locale

getXsd

@AutoEscape
String getXsd()

Returns the xsd of this d d m structure.

Returns:

the xsd of this d d m structure

setXsd

void setXsd(String xsd)

Sets the xsd of this d d m structure.

Parameters:

xsd - the xsd of this d d m structure

getStorageType

@AutoEscape
String getStorageType()

Returns the storage type of this d d m structure.

Returns:

the storage type of this d d m structure

setStorageType

void setStorageType(String storageType)

Sets the storage type of this d d m structure.

Parameters:

storageType - the storage type of this d d m structure

getType

int getType()

Returns the type of this d d m structure.

Returns:

the type of this d d m structure

setType

void setType(int type)

Sets the type of this d d m structure.

Parameters:

type - the type of this d d m structure

isNew

boolean isNew()

Description copied from interface: BaseModel

Returns true if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<DDMStructure>

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

void setNew(boolean n)

Description copied from interface: BaseModel

Sets whether this model instance does not yet exist in the database.

Specified by:

setNew in interface BaseModel<DDMStructure>

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()

Description copied from interface: BaseModel

Returns true if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<DDMStructure>

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

void setCachedModel(boolean cachedModel)

Description copied from interface: BaseModel

Sets whether this model instance was retrieved from the entity cache.

Specified by:

setCachedModel in interface BaseModel<DDMStructure>

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<DDMStructure>

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

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

Returns:

the primary key of this model instance

setPrimaryKeyObj

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

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

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

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DDMStructure>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<DDMStructure>

setExpandoBridgeAttributes

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>

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes( )

getAvailableLanguageIds

String[] getAvailableLanguageIds()

getDefaultLanguageId

String getDefaultLanguageId()

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport()
                                     throws LocaleException

Throws:

LocaleException

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException

Throws:

LocaleException

clone

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(DDMStructure ddmStructure)

Specified by:

compareTo in interface Comparable<DDMStructure>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

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>

Returns:

the cache model object

toEscapedModel

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>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

DDMStructure toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<DDMStructure>

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<DDMStructure>

Returns:

the XML representation of this model instance