@ProviderType public interface ObjectDefinitionModel extends com.liferay.portal.kernel.model.BaseModel<ObjectDefinition>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedAuditedModel
This interface and its corresponding implementation com.liferay.object.model.impl.ObjectDefinitionModelImpl
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.object.model.impl.ObjectDefinitionImpl
.
ObjectDefinition
Modifier and Type | Method and Description |
---|---|
ObjectDefinition |
cloneWithOriginalValues() |
boolean |
getActive()
Returns the active of this object definition.
|
java.lang.String[] |
getAvailableLanguageIds() |
java.lang.String |
getClassName()
Returns the class name of this object definition.
|
long |
getCompanyId()
Returns the company ID of this object definition.
|
java.util.Date |
getCreateDate()
Returns the create date of this object definition.
|
java.lang.String |
getDBTableName()
Returns the db table name of this object definition.
|
java.lang.String |
getDefaultLanguageId() |
long |
getDescriptionObjectFieldId()
Returns the description object field ID of this object definition.
|
java.lang.String |
getLabel()
Returns the label of this object definition.
|
java.lang.String |
getLabel(java.util.Locale locale)
Returns the localized label of this object definition in the language.
|
java.lang.String |
getLabel(java.util.Locale locale,
boolean useDefault)
Returns the localized label of this object definition in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getLabel(java.lang.String languageId)
Returns the localized label of this object definition in the language.
|
java.lang.String |
getLabel(java.lang.String languageId,
boolean useDefault)
Returns the localized label of this object definition in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getLabelCurrentLanguageId() |
java.lang.String |
getLabelCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getLabelMap()
Returns a map of the locales and localized labels of this object definition.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this object definition.
|
long |
getMvccVersion()
Returns the mvcc version of this object definition.
|
java.lang.String |
getName()
Returns the name of this object definition.
|
long |
getObjectDefinitionId()
Returns the object definition ID of this object definition.
|
java.lang.String |
getPanelAppOrder()
Returns the panel app order of this object definition.
|
java.lang.String |
getPanelCategoryKey()
Returns the panel category key of this object definition.
|
java.lang.String |
getPKObjectFieldDBColumnName()
Returns the pk object field db column name of this object definition.
|
java.lang.String |
getPKObjectFieldName()
Returns the pk object field name of this object definition.
|
java.lang.String |
getPluralLabel()
Returns the plural label of this object definition.
|
java.lang.String |
getPluralLabel(java.util.Locale locale)
Returns the localized plural label of this object definition in the language.
|
java.lang.String |
getPluralLabel(java.util.Locale locale,
boolean useDefault)
Returns the localized plural label of this object definition in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getPluralLabel(java.lang.String languageId)
Returns the localized plural label of this object definition in the language.
|
java.lang.String |
getPluralLabel(java.lang.String languageId,
boolean useDefault)
Returns the localized plural label of this object definition in the language, optionally using the default language if no localization exists for the requested language.
|
java.lang.String |
getPluralLabelCurrentLanguageId() |
java.lang.String |
getPluralLabelCurrentValue() |
java.util.Map<java.util.Locale,java.lang.String> |
getPluralLabelMap()
Returns a map of the locales and localized plural labels of this object definition.
|
boolean |
getPortlet()
Returns the portlet of this object definition.
|
long |
getPrimaryKey()
Returns the primary key of this object definition.
|
java.lang.String |
getScope()
Returns the scope of this object definition.
|
int |
getStatus()
Returns the status of this object definition.
|
boolean |
getSystem()
Returns the system of this object definition.
|
long |
getTitleObjectFieldId()
Returns the title object field ID of this object definition.
|
long |
getUserId()
Returns the user ID of this object definition.
|
java.lang.String |
getUserName()
Returns the user name of this object definition.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this object definition.
|
java.lang.String |
getUuid()
Returns the uuid of this object definition.
|
int |
getVersion()
Returns the version of this object definition.
|
boolean |
isActive()
Returns
true if this object definition is active. |
boolean |
isPortlet()
Returns
true if this object definition is portlet. |
boolean |
isSystem()
Returns
true if this object definition is system. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setActive(boolean active)
Sets whether this object definition is active.
|
void |
setClassName(java.lang.String className)
Sets the class name of this object definition.
|
void |
setCompanyId(long companyId)
Sets the company ID of this object definition.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this object definition.
|
void |
setDBTableName(java.lang.String dbTableName)
Sets the db table name of this object definition.
|
void |
setDescriptionObjectFieldId(long descriptionObjectFieldId)
Sets the description object field ID of this object definition.
|
void |
setLabel(java.lang.String label)
Sets the label of this object definition.
|
void |
setLabel(java.lang.String label,
java.util.Locale locale)
Sets the localized label of this object definition in the language.
|
void |
setLabel(java.lang.String label,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized label of this object definition in the language, and sets the default locale.
|
void |
setLabelCurrentLanguageId(java.lang.String languageId) |
void |
setLabelMap(java.util.Map<java.util.Locale,java.lang.String> labelMap)
Sets the localized labels of this object definition from the map of locales and localized labels.
|
void |
setLabelMap(java.util.Map<java.util.Locale,java.lang.String> labelMap,
java.util.Locale defaultLocale)
Sets the localized labels of this object definition from the map of locales and localized labels, and sets the default locale.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this object definition.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this object definition.
|
void |
setName(java.lang.String name)
Sets the name of this object definition.
|
void |
setObjectDefinitionId(long objectDefinitionId)
Sets the object definition ID of this object definition.
|
void |
setPanelAppOrder(java.lang.String panelAppOrder)
Sets the panel app order of this object definition.
|
void |
setPanelCategoryKey(java.lang.String panelCategoryKey)
Sets the panel category key of this object definition.
|
void |
setPKObjectFieldDBColumnName(java.lang.String pkObjectFieldDBColumnName)
Sets the pk object field db column name of this object definition.
|
void |
setPKObjectFieldName(java.lang.String pkObjectFieldName)
Sets the pk object field name of this object definition.
|
void |
setPluralLabel(java.lang.String pluralLabel)
Sets the plural label of this object definition.
|
void |
setPluralLabel(java.lang.String pluralLabel,
java.util.Locale locale)
Sets the localized plural label of this object definition in the language.
|
void |
setPluralLabel(java.lang.String pluralLabel,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized plural label of this object definition in the language, and sets the default locale.
|
void |
setPluralLabelCurrentLanguageId(java.lang.String languageId) |
void |
setPluralLabelMap(java.util.Map<java.util.Locale,java.lang.String> pluralLabelMap)
Sets the localized plural labels of this object definition from the map of locales and localized plural labels.
|
void |
setPluralLabelMap(java.util.Map<java.util.Locale,java.lang.String> pluralLabelMap,
java.util.Locale defaultLocale)
Sets the localized plural labels of this object definition from the map of locales and localized plural labels, and sets the default locale.
|
void |
setPortlet(boolean portlet)
Sets whether this object definition is portlet.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this object definition.
|
void |
setScope(java.lang.String scope)
Sets the scope of this object definition.
|
void |
setStatus(int status)
Sets the status of this object definition.
|
void |
setSystem(boolean system)
Sets whether this object definition is system.
|
void |
setTitleObjectFieldId(long titleObjectFieldId)
Sets the title object field ID of this object definition.
|
void |
setUserId(long userId)
Sets the user ID of this object definition.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this object definition.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this object definition.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this object definition.
|
void |
setVersion(int version)
Sets the version of this object definition.
|
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this object definitionlong getMvccVersion()
getMvccVersion
in interface com.liferay.portal.kernel.model.MVCCModel
void setMvccVersion(long mvccVersion)
setMvccVersion
in interface com.liferay.portal.kernel.model.MVCCModel
mvccVersion
- the mvcc version of this object definition@AutoEscape java.lang.String getUuid()
getUuid
in interface com.liferay.portal.kernel.model.StagedModel
void setUuid(java.lang.String uuid)
setUuid
in interface com.liferay.portal.kernel.model.StagedModel
uuid
- the uuid of this object definitionlong getObjectDefinitionId()
void setObjectDefinitionId(long objectDefinitionId)
objectDefinitionId
- the object definition ID of this object definitionlong getCompanyId()
getCompanyId
in interface com.liferay.portal.kernel.model.AuditedModel
getCompanyId
in interface com.liferay.portal.kernel.model.ShardedModel
getCompanyId
in interface com.liferay.portal.kernel.model.StagedModel
void setCompanyId(long companyId)
setCompanyId
in interface com.liferay.portal.kernel.model.AuditedModel
setCompanyId
in interface com.liferay.portal.kernel.model.ShardedModel
setCompanyId
in interface com.liferay.portal.kernel.model.StagedModel
companyId
- the company ID of this object definitionlong getUserId()
getUserId
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserId(long userId)
setUserId
in interface com.liferay.portal.kernel.model.AuditedModel
userId
- the user ID of this object definitionjava.lang.String getUserUuid()
getUserUuid
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserUuid(java.lang.String userUuid)
setUserUuid
in interface com.liferay.portal.kernel.model.AuditedModel
userUuid
- the user uuid of this object definition@AutoEscape java.lang.String getUserName()
getUserName
in interface com.liferay.portal.kernel.model.AuditedModel
void setUserName(java.lang.String userName)
setUserName
in interface com.liferay.portal.kernel.model.AuditedModel
userName
- the user name of this object definitionjava.util.Date getCreateDate()
getCreateDate
in interface com.liferay.portal.kernel.model.AuditedModel
getCreateDate
in interface com.liferay.portal.kernel.model.StagedModel
void setCreateDate(java.util.Date createDate)
setCreateDate
in interface com.liferay.portal.kernel.model.AuditedModel
setCreateDate
in interface com.liferay.portal.kernel.model.StagedModel
createDate
- the create date of this object definitionjava.util.Date getModifiedDate()
getModifiedDate
in interface com.liferay.portal.kernel.model.AuditedModel
getModifiedDate
in interface com.liferay.portal.kernel.model.StagedModel
void setModifiedDate(java.util.Date modifiedDate)
setModifiedDate
in interface com.liferay.portal.kernel.model.AuditedModel
setModifiedDate
in interface com.liferay.portal.kernel.model.StagedModel
modifiedDate
- the modified date of this object definitionlong getDescriptionObjectFieldId()
void setDescriptionObjectFieldId(long descriptionObjectFieldId)
descriptionObjectFieldId
- the description object field ID of this object definitionlong getTitleObjectFieldId()
void setTitleObjectFieldId(long titleObjectFieldId)
titleObjectFieldId
- the title object field ID of this object definitionboolean getActive()
boolean isActive()
true
if this object definition is active.true
if this object definition is active; false
otherwisevoid setActive(boolean active)
active
- the active of this object definition@AutoEscape java.lang.String getDBTableName()
void setDBTableName(java.lang.String dbTableName)
dbTableName
- the db table name of this object definitionjava.lang.String getLabel()
@AutoEscape java.lang.String getLabel(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getLabel(java.util.Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getLabel(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getLabel(java.lang.String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language@AutoEscape java.lang.String getLabelCurrentLanguageId()
@AutoEscape java.lang.String getLabelCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getLabelMap()
void setLabel(java.lang.String label)
label
- the label of this object definitionvoid setLabel(java.lang.String label, java.util.Locale locale)
label
- the localized label of this object definitionlocale
- the locale of the languagevoid setLabel(java.lang.String label, java.util.Locale locale, java.util.Locale defaultLocale)
label
- the localized label of this object definitionlocale
- the locale of the languagedefaultLocale
- the default localevoid setLabelCurrentLanguageId(java.lang.String languageId)
void setLabelMap(java.util.Map<java.util.Locale,java.lang.String> labelMap)
labelMap
- the locales and localized labels of this object definitionvoid setLabelMap(java.util.Map<java.util.Locale,java.lang.String> labelMap, java.util.Locale defaultLocale)
labelMap
- the locales and localized labels of this object definitiondefaultLocale
- the default locale@AutoEscape java.lang.String getClassName()
void setClassName(java.lang.String className)
className
- the class name of this object definition@AutoEscape java.lang.String getName()
void setName(java.lang.String name)
name
- the name of this object definition@AutoEscape java.lang.String getPanelAppOrder()
void setPanelAppOrder(java.lang.String panelAppOrder)
panelAppOrder
- the panel app order of this object definition@AutoEscape java.lang.String getPanelCategoryKey()
void setPanelCategoryKey(java.lang.String panelCategoryKey)
panelCategoryKey
- the panel category key of this object definition@AutoEscape java.lang.String getPKObjectFieldDBColumnName()
void setPKObjectFieldDBColumnName(java.lang.String pkObjectFieldDBColumnName)
pkObjectFieldDBColumnName
- the pk object field db column name of this object definition@AutoEscape java.lang.String getPKObjectFieldName()
void setPKObjectFieldName(java.lang.String pkObjectFieldName)
pkObjectFieldName
- the pk object field name of this object definitionjava.lang.String getPluralLabel()
@AutoEscape java.lang.String getPluralLabel(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getPluralLabel(java.util.Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape java.lang.String getPluralLabel(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getPluralLabel(java.lang.String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language@AutoEscape java.lang.String getPluralLabelCurrentLanguageId()
@AutoEscape java.lang.String getPluralLabelCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getPluralLabelMap()
void setPluralLabel(java.lang.String pluralLabel)
pluralLabel
- the plural label of this object definitionvoid setPluralLabel(java.lang.String pluralLabel, java.util.Locale locale)
pluralLabel
- the localized plural label of this object definitionlocale
- the locale of the languagevoid setPluralLabel(java.lang.String pluralLabel, java.util.Locale locale, java.util.Locale defaultLocale)
pluralLabel
- the localized plural label of this object definitionlocale
- the locale of the languagedefaultLocale
- the default localevoid setPluralLabelCurrentLanguageId(java.lang.String languageId)
void setPluralLabelMap(java.util.Map<java.util.Locale,java.lang.String> pluralLabelMap)
pluralLabelMap
- the locales and localized plural labels of this object definitionvoid setPluralLabelMap(java.util.Map<java.util.Locale,java.lang.String> pluralLabelMap, java.util.Locale defaultLocale)
pluralLabelMap
- the locales and localized plural labels of this object definitiondefaultLocale
- the default localeboolean getPortlet()
boolean isPortlet()
true
if this object definition is portlet.true
if this object definition is portlet; false
otherwisevoid setPortlet(boolean portlet)
portlet
- the portlet of this object definition@AutoEscape java.lang.String getScope()
void setScope(java.lang.String scope)
scope
- the scope of this object definitionboolean getSystem()
boolean isSystem()
true
if this object definition is system.true
if this object definition is system; false
otherwisevoid setSystem(boolean system)
system
- the system of this object definitionint getVersion()
void setVersion(int version)
version
- the version of this object definitionint getStatus()
void setStatus(int status)
status
- the status of this object definitionjava.lang.String[] getAvailableLanguageIds()
getAvailableLanguageIds
in interface com.liferay.portal.kernel.model.LocalizedModel
java.lang.String getDefaultLanguageId()
getDefaultLanguageId
in interface com.liferay.portal.kernel.model.LocalizedModel
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport
in interface com.liferay.portal.kernel.model.LocalizedModel
com.liferay.portal.kernel.exception.LocaleException
void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException
prepareLocalizedFieldsForImport
in interface com.liferay.portal.kernel.model.LocalizedModel
com.liferay.portal.kernel.exception.LocaleException
ObjectDefinition cloneWithOriginalValues()
cloneWithOriginalValues
in interface com.liferay.portal.kernel.model.BaseModel<ObjectDefinition>