Liferay 7.0-ce-m3

com.liferay.portlet.dynamicdatamapping.model
Interface DDMTemplateVersionModel

All Superinterfaces:
BaseModel<DDMTemplateVersion>, ClassedModel, Cloneable, Comparable<DDMTemplateVersion>, LocalizedModel, Serializable
All Known Subinterfaces:
DDMTemplateVersion
All Known Implementing Classes:
DDMTemplateVersionBaseImpl, DDMTemplateVersionImpl, DDMTemplateVersionModelImpl, DDMTemplateVersionWrapper

@ProviderType
public interface DDMTemplateVersionModel
extends BaseModel<DDMTemplateVersion>, LocalizedModel

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

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

See Also:
DDMTemplateVersion, DDMTemplateVersionImpl, DDMTemplateVersionModelImpl
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(DDMTemplateVersion ddmTemplateVersion)
           
 String[] getAvailableLanguageIds()
           
 long getCompanyId()
          Returns the company ID of this d d m template version.
 Date getCreateDate()
          Returns the create date of this d d m template version.
 String getDefaultLanguageId()
           
 String getDescription()
          Returns the description of this d d m template version.
 String getDescription(Locale locale)
          Returns the localized description of this d d m template version in the language.
 String getDescription(Locale locale, boolean useDefault)
          Returns the localized description of this d d m template version 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 template version in the language.
 String getDescription(String languageId, boolean useDefault)
          Returns the localized description of this d d m template version 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 template version.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getGroupId()
          Returns the group ID of this d d m template version.
 String getLanguage()
          Returns the language of this d d m template version.
 String getName()
          Returns the name of this d d m template version.
 String getName(Locale locale)
          Returns the localized name of this d d m template version in the language.
 String getName(Locale locale, boolean useDefault)
          Returns the localized name of this d d m template version 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 template version in the language.
 String getName(String languageId, boolean useDefault)
          Returns the localized name of this d d m template version 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 template version.
 long getPrimaryKey()
          Returns the primary key of this d d m template version.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 String getScript()
          Returns the script of this d d m template version.
 long getTemplateId()
          Returns the template ID of this d d m template version.
 long getTemplateVersionId()
          Returns the template version ID of this d d m template version.
 long getUserId()
          Returns the user ID of this d d m template version.
 String getUserName()
          Returns the user name of this d d m template version.
 String getUserUuid()
          Returns the user uuid of this d d m template version.
 String getVersion()
          Returns the version of this d d m template version.
 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 setCompanyId(long companyId)
          Sets the company ID of this d d m template version.
 void setCreateDate(Date createDate)
          Sets the create date of this d d m template version.
 void setDescription(String description)
          Sets the description of this d d m template version.
 void setDescription(String description, Locale locale)
          Sets the localized description of this d d m template version in the language.
 void setDescription(String description, Locale locale, Locale defaultLocale)
          Sets the localized description of this d d m template version 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 template version 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 template version 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 template version.
 void setLanguage(String language)
          Sets the language of this d d m template version.
 void setName(String name)
          Sets the name of this d d m template version.
 void setName(String name, Locale locale)
          Sets the localized name of this d d m template version in the language.
 void setName(String name, Locale locale, Locale defaultLocale)
          Sets the localized name of this d d m template version 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 template version 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 template version 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 setPrimaryKey(long primaryKey)
          Sets the primary key of this d d m template version.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setScript(String script)
          Sets the script of this d d m template version.
 void setTemplateId(long templateId)
          Sets the template ID of this d d m template version.
 void setTemplateVersionId(long templateVersionId)
          Sets the template version ID of this d d m template version.
 void setUserId(long userId)
          Sets the user ID of this d d m template version.
 void setUserName(String userName)
          Sets the user name of this d d m template version.
 void setUserUuid(String userUuid)
          Sets the user uuid of this d d m template version.
 void setVersion(String version)
          Sets the version of this d d m template version.
 CacheModel<DDMTemplateVersion> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 DDMTemplateVersion toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 DDMTemplateVersion toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

long getPrimaryKey()
Returns the primary key of this d d m template version.

Returns:
the primary key of this d d m template version

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this d d m template version.

Parameters:
primaryKey - the primary key of this d d m template version

getTemplateVersionId

long getTemplateVersionId()
Returns the template version ID of this d d m template version.

Returns:
the template version ID of this d d m template version

setTemplateVersionId

void setTemplateVersionId(long templateVersionId)
Sets the template version ID of this d d m template version.

Parameters:
templateVersionId - the template version ID of this d d m template version

getGroupId

long getGroupId()
Returns the group ID of this d d m template version.

Returns:
the group ID of this d d m template version

setGroupId

void setGroupId(long groupId)
Sets the group ID of this d d m template version.

Parameters:
groupId - the group ID of this d d m template version

getCompanyId

long getCompanyId()
Returns the company ID of this d d m template version.

Returns:
the company ID of this d d m template version

setCompanyId

void setCompanyId(long companyId)
Sets the company ID of this d d m template version.

Parameters:
companyId - the company ID of this d d m template version

getUserId

long getUserId()
Returns the user ID of this d d m template version.

Returns:
the user ID of this d d m template version

setUserId

void setUserId(long userId)
Sets the user ID of this d d m template version.

Parameters:
userId - the user ID of this d d m template version

getUserUuid

String getUserUuid()
Returns the user uuid of this d d m template version.

Returns:
the user uuid of this d d m template version

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this d d m template version.

Parameters:
userUuid - the user uuid of this d d m template version

getUserName

@AutoEscape
String getUserName()
Returns the user name of this d d m template version.

Returns:
the user name of this d d m template version

setUserName

void setUserName(String userName)
Sets the user name of this d d m template version.

Parameters:
userName - the user name of this d d m template version

getCreateDate

Date getCreateDate()
Returns the create date of this d d m template version.

Returns:
the create date of this d d m template version

setCreateDate

void setCreateDate(Date createDate)
Sets the create date of this d d m template version.

Parameters:
createDate - the create date of this d d m template version

getTemplateId

long getTemplateId()
Returns the template ID of this d d m template version.

Returns:
the template ID of this d d m template version

setTemplateId

void setTemplateId(long templateId)
Sets the template ID of this d d m template version.

Parameters:
templateId - the template ID of this d d m template version

getVersion

@AutoEscape
String getVersion()
Returns the version of this d d m template version.

Returns:
the version of this d d m template version

setVersion

void setVersion(String version)
Sets the version of this d d m template version.

Parameters:
version - the version of this d d m template version

getName

String getName()
Returns the name of this d d m template version.

Returns:
the name of this d d m template version

getName

@AutoEscape
String getName(Locale locale)
Returns the localized name of this d d m template version 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 template version

getName

@AutoEscape
String getName(Locale locale,
                          boolean useDefault)
Returns the localized name of this d d m template version 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 template version. 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 template version 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 template version

getName

@AutoEscape
String getName(String languageId,
                          boolean useDefault)
Returns the localized name of this d d m template version 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 template version

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 template version.

Returns:
the locales and localized names of this d d m template version

setName

void setName(String name)
Sets the name of this d d m template version.

Parameters:
name - the name of this d d m template version

setName

void setName(String name,
             Locale locale)
Sets the localized name of this d d m template version in the language.

Parameters:
name - the localized name of this d d m template version
locale - the locale of the language

setName

void setName(String name,
             Locale locale,
             Locale defaultLocale)
Sets the localized name of this d d m template version in the language, and sets the default locale.

Parameters:
name - the localized name of this d d m template version
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 template version from the map of locales and localized names.

Parameters:
nameMap - the locales and localized names of this d d m template version

setNameMap

void setNameMap(Map<Locale,String> nameMap,
                Locale defaultLocale)
Sets the localized names of this d d m template version 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 template version
defaultLocale - the default locale

getDescription

String getDescription()
Returns the description of this d d m template version.

Returns:
the description of this d d m template version

getDescription

@AutoEscape
String getDescription(Locale locale)
Returns the localized description of this d d m template version 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 template version

getDescription

@AutoEscape
String getDescription(Locale locale,
                                 boolean useDefault)
Returns the localized description of this d d m template version 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 template version. 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 template version 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 template version

getDescription

@AutoEscape
String getDescription(String languageId,
                                 boolean useDefault)
Returns the localized description of this d d m template version 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 template version

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 template version.

Returns:
the locales and localized descriptions of this d d m template version

setDescription

void setDescription(String description)
Sets the description of this d d m template version.

Parameters:
description - the description of this d d m template version

setDescription

void setDescription(String description,
                    Locale locale)
Sets the localized description of this d d m template version in the language.

Parameters:
description - the localized description of this d d m template version
locale - the locale of the language

setDescription

void setDescription(String description,
                    Locale locale,
                    Locale defaultLocale)
Sets the localized description of this d d m template version in the language, and sets the default locale.

Parameters:
description - the localized description of this d d m template version
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 template version from the map of locales and localized descriptions.

Parameters:
descriptionMap - the locales and localized descriptions of this d d m template version

setDescriptionMap

void setDescriptionMap(Map<Locale,String> descriptionMap,
                       Locale defaultLocale)
Sets the localized descriptions of this d d m template version 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 template version
defaultLocale - the default locale

getLanguage

@AutoEscape
String getLanguage()
Returns the language of this d d m template version.

Returns:
the language of this d d m template version

setLanguage

void setLanguage(String language)
Sets the language of this d d m template version.

Parameters:
language - the language of this d d m template version

getScript

@AutoEscape
String getScript()
Returns the script of this d d m template version.

Returns:
the script of this d d m template version

setScript

void setScript(String script)
Sets the script of this d d m template version.

Parameters:
script - the script of this d d m template version

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

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<DDMTemplateVersion>

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<DDMTemplateVersion>
Parameters:
serviceContext - the service context to be applied
See Also:
ServiceContext.getExpandoBridgeAttributes( )

getAvailableLanguageIds

String[] getAvailableLanguageIds()
Specified by:
getAvailableLanguageIds in interface LocalizedModel

getDefaultLanguageId

String getDefaultLanguageId()
Specified by:
getDefaultLanguageId in interface LocalizedModel

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport()
                                     throws LocaleException
Specified by:
prepareLocalizedFieldsForImport in interface LocalizedModel
Throws:
LocaleException

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException
Specified by:
prepareLocalizedFieldsForImport in interface LocalizedModel
Throws:
LocaleException

clone

Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<DDMTemplateVersion>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(DDMTemplateVersion ddmTemplateVersion)
Specified by:
compareTo in interface Comparable<DDMTemplateVersion>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

CacheModel<DDMTemplateVersion> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<DDMTemplateVersion>
Returns:
the cache model object

toEscapedModel

DDMTemplateVersion 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<DDMTemplateVersion>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

DDMTemplateVersion toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<DDMTemplateVersion>

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<DDMTemplateVersion>
Returns:
the XML representation of this model instance

Liferay 7.0-ce-m3