com.liferay.dynamic.data.mapping.model

Interface DDMDataProviderInstanceModel

All Superinterfaces:

com.liferay.portal.kernel.model.AuditedModel, com.liferay.portal.kernel.model.BaseModel<DDMDataProviderInstance>, com.liferay.portal.kernel.model.ClassedModel, java.lang.Cloneable, java.lang.Comparable<DDMDataProviderInstance>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMDataProviderInstance>, com.liferay.portal.kernel.model.GroupedModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, java.io.Serializable, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel, com.liferay.portal.kernel.model.StagedModel

All Known Subinterfaces:

DDMDataProviderInstance

All Known Implementing Classes:

DDMDataProviderInstanceWrapper

@ProviderType
public interface DDMDataProviderInstanceModel
extends com.liferay.portal.kernel.model.BaseModel<DDMDataProviderInstance>, com.liferay.portal.kernel.model.change.tracking.CTModel<DDMDataProviderInstance>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel

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

This interface and its corresponding implementation com.liferay.dynamic.data.mapping.model.impl.DDMDataProviderInstanceModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.dynamic.data.mapping.model.impl.DDMDataProviderInstanceImpl.

See Also:

DDMDataProviderInstance

Generated:

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAvailableLanguageIds()
long	getCompanyId() Returns the company ID of this ddm data provider instance.
java.util.Date	getCreateDate() Returns the create date of this ddm data provider instance.
long	getCtCollectionId() Returns the ct collection ID of this ddm data provider instance.
long	getDataProviderInstanceId() Returns the data provider instance ID of this ddm data provider instance.
java.lang.String	getDefaultLanguageId()
java.lang.String	getDefinition() Returns the definition of this ddm data provider instance.
java.lang.String	getDescription() Returns the description of this ddm data provider instance.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this ddm data provider instance in the language.
java.lang.String	getDescription(java.util.Locale locale, boolean useDefault) Returns the localized description of this ddm data provider instance in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getDescription(java.lang.String languageId) Returns the localized description of this ddm data provider instance in the language.
java.lang.String	getDescription(java.lang.String languageId, boolean useDefault) Returns the localized description of this ddm data provider instance in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getDescriptionCurrentLanguageId()
java.lang.String	getDescriptionCurrentValue()
java.util.Map<java.util.Locale,java.lang.String>	getDescriptionMap() Returns a map of the locales and localized descriptions of this ddm data provider instance.
long	getGroupId() Returns the group ID of this ddm data provider instance.
java.util.Date	getLastPublishDate() Returns the last publish date of this ddm data provider instance.
java.util.Date	getModifiedDate() Returns the modified date of this ddm data provider instance.
long	getMvccVersion() Returns the mvcc version of this ddm data provider instance.
java.lang.String	getName() Returns the name of this ddm data provider instance.
java.lang.String	getName(java.util.Locale locale) Returns the localized name of this ddm data provider instance in the language.
java.lang.String	getName(java.util.Locale locale, boolean useDefault) Returns the localized name of this ddm data provider instance in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getName(java.lang.String languageId) Returns the localized name of this ddm data provider instance in the language.
java.lang.String	getName(java.lang.String languageId, boolean useDefault) Returns the localized name of this ddm data provider instance in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getNameCurrentLanguageId()
java.lang.String	getNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String>	getNameMap() Returns a map of the locales and localized names of this ddm data provider instance.
long	getPrimaryKey() Returns the primary key of this ddm data provider instance.
java.lang.String	getType() Returns the type of this ddm data provider instance.
long	getUserId() Returns the user ID of this ddm data provider instance.
java.lang.String	getUserName() Returns the user name of this ddm data provider instance.
java.lang.String	getUserUuid() Returns the user uuid of this ddm data provider instance.
java.lang.String	getUuid() Returns the uuid of this ddm data provider instance.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
void	setCompanyId(long companyId) Sets the company ID of this ddm data provider instance.
void	setCreateDate(java.util.Date createDate) Sets the create date of this ddm data provider instance.
void	setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this ddm data provider instance.
void	setDataProviderInstanceId(long dataProviderInstanceId) Sets the data provider instance ID of this ddm data provider instance.
void	setDefinition(java.lang.String definition) Sets the definition of this ddm data provider instance.
void	setDescription(java.lang.String description) Sets the description of this ddm data provider instance.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this ddm data provider instance in the language.
void	setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized description of this ddm data provider instance in the language, and sets the default locale.
void	setDescriptionCurrentLanguageId(java.lang.String languageId)
void	setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap) Sets the localized descriptions of this ddm data provider instance from the map of locales and localized descriptions.
void	setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Locale defaultLocale) Sets the localized descriptions of this ddm data provider instance from the map of locales and localized descriptions, and sets the default locale.
void	setGroupId(long groupId) Sets the group ID of this ddm data provider instance.
void	setLastPublishDate(java.util.Date lastPublishDate) Sets the last publish date of this ddm data provider instance.
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this ddm data provider instance.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this ddm data provider instance.
void	setName(java.lang.String name) Sets the name of this ddm data provider instance.
void	setName(java.lang.String name, java.util.Locale locale) Sets the localized name of this ddm data provider instance in the language.
void	setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized name of this ddm data provider instance in the language, and sets the default locale.
void	setNameCurrentLanguageId(java.lang.String languageId)
void	setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap) Sets the localized names of this ddm data provider instance from the map of locales and localized names.
void	setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Locale defaultLocale) Sets the localized names of this ddm data provider instance from the map of locales and localized names, and sets the default locale.
void	setPrimaryKey(long primaryKey) Sets the primary key of this ddm data provider instance.
void	setType(java.lang.String type) Sets the type of this ddm data provider instance.
void	setUserId(long userId) Sets the user ID of this ddm data provider instance.
void	setUserName(java.lang.String userName) Sets the user name of this ddm data provider instance.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this ddm data provider instance.
void	setUuid(java.lang.String uuid) Sets the uuid of this ddm data provider instance.

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

clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString

Methods inherited from interface java.lang.Comparable

compareTo

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

getModelClass, getModelClassName

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

clone, getStagedModelType

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this ddm data provider instance.

Specified by:

getPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMDataProviderInstance>

Returns:

the primary key of this ddm data provider instance

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this ddm data provider instance.

Specified by:

setPrimaryKey in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMDataProviderInstance>

Parameters:

primaryKey - the primary key of this ddm data provider instance

getMvccVersion

long getMvccVersion()

Returns the mvcc version of this ddm data provider instance.

Specified by:

getMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel

Returns:

the mvcc version of this ddm data provider instance

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this ddm data provider instance.

Specified by:

setMvccVersion in interface com.liferay.portal.kernel.model.MVCCModel

Parameters:

mvccVersion - the mvcc version of this ddm data provider instance

getCtCollectionId

long getCtCollectionId()

Returns the ct collection ID of this ddm data provider instance.

Specified by:

getCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMDataProviderInstance>

Returns:

the ct collection ID of this ddm data provider instance

setCtCollectionId

void setCtCollectionId(long ctCollectionId)

Sets the ct collection ID of this ddm data provider instance.

Specified by:

setCtCollectionId in interface com.liferay.portal.kernel.model.change.tracking.CTModel<DDMDataProviderInstance>

Parameters:

ctCollectionId - the ct collection ID of this ddm data provider instance

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this ddm data provider instance.

Specified by:

getUuid in interface com.liferay.portal.kernel.model.StagedModel

Returns:

the uuid of this ddm data provider instance

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this ddm data provider instance.

Specified by:

setUuid in interface com.liferay.portal.kernel.model.StagedModel

Parameters:

uuid - the uuid of this ddm data provider instance

getDataProviderInstanceId

long getDataProviderInstanceId()

Returns the data provider instance ID of this ddm data provider instance.

Returns:

the data provider instance ID of this ddm data provider instance

setDataProviderInstanceId

void setDataProviderInstanceId(long dataProviderInstanceId)

Sets the data provider instance ID of this ddm data provider instance.

Parameters:

dataProviderInstanceId - the data provider instance ID of this ddm data provider instance

getGroupId

long getGroupId()

Returns the group ID of this ddm data provider instance.

Specified by:

getGroupId in interface com.liferay.portal.kernel.model.GroupedModel

Returns:

the group ID of this ddm data provider instance

setGroupId

void setGroupId(long groupId)

Sets the group ID of this ddm data provider instance.

Specified by:

setGroupId in interface com.liferay.portal.kernel.model.GroupedModel

Parameters:

groupId - the group ID of this ddm data provider instance

getCompanyId

long getCompanyId()

Returns the company ID of this ddm data provider instance.

Specified by:

getCompanyId in interface com.liferay.portal.kernel.model.AuditedModel

Specified by:

getCompanyId in interface com.liferay.portal.kernel.model.ShardedModel

Specified by:

getCompanyId in interface com.liferay.portal.kernel.model.StagedModel

Returns:

the company ID of this ddm data provider instance

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this ddm data provider instance.

Specified by:

setCompanyId in interface com.liferay.portal.kernel.model.AuditedModel

Specified by:

setCompanyId in interface com.liferay.portal.kernel.model.ShardedModel

Specified by:

setCompanyId in interface com.liferay.portal.kernel.model.StagedModel

Parameters:

companyId - the company ID of this ddm data provider instance

getUserId

long getUserId()

Returns the user ID of this ddm data provider instance.

Specified by:

getUserId in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the user ID of this ddm data provider instance

setUserId

void setUserId(long userId)

Sets the user ID of this ddm data provider instance.

Specified by:

setUserId in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

userId - the user ID of this ddm data provider instance

getUserUuid

java.lang.String getUserUuid()

Returns the user uuid of this ddm data provider instance.

Specified by:

getUserUuid in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the user uuid of this ddm data provider instance

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this ddm data provider instance.

Specified by:

setUserUuid in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

userUuid - the user uuid of this ddm data provider instance

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this ddm data provider instance.

Specified by:

getUserName in interface com.liferay.portal.kernel.model.AuditedModel

Returns:

the user name of this ddm data provider instance

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this ddm data provider instance.

Specified by:

setUserName in interface com.liferay.portal.kernel.model.AuditedModel

Parameters:

userName - the user name of this ddm data provider instance

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this ddm data provider instance.

Specified by:

getCreateDate in interface com.liferay.portal.kernel.model.AuditedModel

Specified by:

getCreateDate in interface com.liferay.portal.kernel.model.StagedModel

Returns:

the create date of this ddm data provider instance

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this ddm data provider instance.

Specified by:

setCreateDate in interface com.liferay.portal.kernel.model.AuditedModel

Specified by:

setCreateDate in interface com.liferay.portal.kernel.model.StagedModel

Parameters:

createDate - the create date of this ddm data provider instance

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this ddm data provider instance.

Specified by:

getModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel

Specified by:

getModifiedDate in interface com.liferay.portal.kernel.model.StagedModel

Returns:

the modified date of this ddm data provider instance

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this ddm data provider instance.

Specified by:

setModifiedDate in interface com.liferay.portal.kernel.model.AuditedModel

Specified by:

setModifiedDate in interface com.liferay.portal.kernel.model.StagedModel

Parameters:

modifiedDate - the modified date of this ddm data provider instance

getName

java.lang.String getName()

Returns the name of this ddm data provider instance.

Returns:

the name of this ddm data provider instance

getName

@AutoEscape
java.lang.String getName(java.util.Locale locale)

Returns the localized name of this ddm data provider instance 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 ddm data provider instance

getName

@AutoEscape
java.lang.String getName(java.util.Locale locale,
                                     boolean useDefault)

Returns the localized name of this ddm data provider instance 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 ddm data provider instance. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

@AutoEscape
java.lang.String getName(java.lang.String languageId)

Returns the localized name of this ddm data provider instance 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 ddm data provider instance

getName

@AutoEscape
java.lang.String getName(java.lang.String languageId,
                                     boolean useDefault)

Returns the localized name of this ddm data provider instance 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 ddm data provider instance

getNameCurrentLanguageId

@AutoEscape
java.lang.String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
java.lang.String getNameCurrentValue()

getNameMap

java.util.Map<java.util.Locale,java.lang.String> getNameMap()

Returns a map of the locales and localized names of this ddm data provider instance.

Returns:

the locales and localized names of this ddm data provider instance

setName

void setName(java.lang.String name)

Sets the name of this ddm data provider instance.

Parameters:

name - the name of this ddm data provider instance

setName

void setName(java.lang.String name,
             java.util.Locale locale)

Sets the localized name of this ddm data provider instance in the language.

Parameters:

name - the localized name of this ddm data provider instance

locale - the locale of the language

setName

void setName(java.lang.String name,
             java.util.Locale locale,
             java.util.Locale defaultLocale)

Sets the localized name of this ddm data provider instance in the language, and sets the default locale.

Parameters:

name - the localized name of this ddm data provider instance

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

void setNameCurrentLanguageId(java.lang.String languageId)

setNameMap

void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)

Sets the localized names of this ddm data provider instance from the map of locales and localized names.

Parameters:

nameMap - the locales and localized names of this ddm data provider instance

setNameMap

void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
                java.util.Locale defaultLocale)

Sets the localized names of this ddm data provider instance from the map of locales and localized names, and sets the default locale.

Parameters:

nameMap - the locales and localized names of this ddm data provider instance

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this ddm data provider instance.

Returns:

the description of this ddm data provider instance

getDescription

@AutoEscape
java.lang.String getDescription(java.util.Locale locale)

Returns the localized description of this ddm data provider instance 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 ddm data provider instance

getDescription

@AutoEscape
java.lang.String getDescription(java.util.Locale locale,
                                            boolean useDefault)

Returns the localized description of this ddm data provider instance 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 ddm data provider instance. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

@AutoEscape
java.lang.String getDescription(java.lang.String languageId)

Returns the localized description of this ddm data provider instance 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 ddm data provider instance

getDescription

@AutoEscape
java.lang.String getDescription(java.lang.String languageId,
                                            boolean useDefault)

Returns the localized description of this ddm data provider instance 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 ddm data provider instance

getDescriptionCurrentLanguageId

@AutoEscape
java.lang.String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
java.lang.String getDescriptionCurrentValue()

getDescriptionMap

java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()

Returns a map of the locales and localized descriptions of this ddm data provider instance.

Returns:

the locales and localized descriptions of this ddm data provider instance

setDescription

void setDescription(java.lang.String description)

Sets the description of this ddm data provider instance.

Parameters:

description - the description of this ddm data provider instance

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

Sets the localized description of this ddm data provider instance in the language.

Parameters:

description - the localized description of this ddm data provider instance

locale - the locale of the language

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale,
                    java.util.Locale defaultLocale)

Sets the localized description of this ddm data provider instance in the language, and sets the default locale.

Parameters:

description - the localized description of this ddm data provider instance

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(java.lang.String languageId)

setDescriptionMap

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)

Sets the localized descriptions of this ddm data provider instance from the map of locales and localized descriptions.

Parameters:

descriptionMap - the locales and localized descriptions of this ddm data provider instance

setDescriptionMap

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                       java.util.Locale defaultLocale)

Sets the localized descriptions of this ddm data provider instance from the map of locales and localized descriptions, and sets the default locale.

Parameters:

descriptionMap - the locales and localized descriptions of this ddm data provider instance

defaultLocale - the default locale

getDefinition

@AutoEscape
java.lang.String getDefinition()

Returns the definition of this ddm data provider instance.

Returns:

the definition of this ddm data provider instance

setDefinition

void setDefinition(java.lang.String definition)

Sets the definition of this ddm data provider instance.

Parameters:

definition - the definition of this ddm data provider instance

getType

@AutoEscape
java.lang.String getType()

Returns the type of this ddm data provider instance.

Returns:

the type of this ddm data provider instance

setType

void setType(java.lang.String type)

Sets the type of this ddm data provider instance.

Parameters:

type - the type of this ddm data provider instance

getLastPublishDate

java.util.Date getLastPublishDate()

Returns the last publish date of this ddm data provider instance.

Specified by:

getLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModel

Returns:

the last publish date of this ddm data provider instance

setLastPublishDate

void setLastPublishDate(java.util.Date lastPublishDate)

Sets the last publish date of this ddm data provider instance.

Specified by:

setLastPublishDate in interface com.liferay.portal.kernel.model.StagedGroupedModel

Parameters:

lastPublishDate - the last publish date of this ddm data provider instance

getAvailableLanguageIds

java.lang.String[] getAvailableLanguageIds()

Specified by:

getAvailableLanguageIds in interface com.liferay.portal.kernel.model.LocalizedModel

getDefaultLanguageId

java.lang.String getDefaultLanguageId()

Specified by:

getDefaultLanguageId in interface com.liferay.portal.kernel.model.LocalizedModel

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport()
                              throws com.liferay.portal.kernel.exception.LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel

Throws:

com.liferay.portal.kernel.exception.LocaleException

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
                              throws com.liferay.portal.kernel.exception.LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface com.liferay.portal.kernel.model.LocalizedModel

Throws:

com.liferay.portal.kernel.exception.LocaleException