@ProviderType public interface ObjectLayoutModel extends com.liferay.portal.kernel.model.BaseModel<ObjectLayout>, 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.ObjectLayoutModelImpl
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.ObjectLayoutImpl
.
ObjectLayout
Modifier and Type | Method and Description |
---|---|
ObjectLayout |
cloneWithOriginalValues() |
java.lang.String[] |
getAvailableLanguageIds() |
long |
getCompanyId()
Returns the company ID of this object layout.
|
java.util.Date |
getCreateDate()
Returns the create date of this object layout.
|
java.lang.String |
getDefaultLanguageId() |
boolean |
getDefaultObjectLayout()
Returns the default object layout of this object layout.
|
java.util.Date |
getModifiedDate()
Returns the modified date of this object layout.
|
long |
getMvccVersion()
Returns the mvcc version of this object layout.
|
java.lang.String |
getName()
Returns the name of this object layout.
|
java.lang.String |
getName(java.util.Locale locale)
Returns the localized name of this object layout in the language.
|
java.lang.String |
getName(java.util.Locale locale,
boolean useDefault)
Returns the localized name of this object layout 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 object layout in the language.
|
java.lang.String |
getName(java.lang.String languageId,
boolean useDefault)
Returns the localized name of this object layout 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 object layout.
|
long |
getObjectDefinitionId()
Returns the object definition ID of this object layout.
|
long |
getObjectLayoutId()
Returns the object layout ID of this object layout.
|
long |
getPrimaryKey()
Returns the primary key of this object layout.
|
long |
getUserId()
Returns the user ID of this object layout.
|
java.lang.String |
getUserName()
Returns the user name of this object layout.
|
java.lang.String |
getUserUuid()
Returns the user uuid of this object layout.
|
java.lang.String |
getUuid()
Returns the uuid of this object layout.
|
boolean |
isDefaultObjectLayout()
Returns
true if this object layout is default object layout. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale) |
void |
setCompanyId(long companyId)
Sets the company ID of this object layout.
|
void |
setCreateDate(java.util.Date createDate)
Sets the create date of this object layout.
|
void |
setDefaultObjectLayout(boolean defaultObjectLayout)
Sets whether this object layout is default object layout.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Sets the modified date of this object layout.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this object layout.
|
void |
setName(java.lang.String name)
Sets the name of this object layout.
|
void |
setName(java.lang.String name,
java.util.Locale locale)
Sets the localized name of this object layout in the language.
|
void |
setName(java.lang.String name,
java.util.Locale locale,
java.util.Locale defaultLocale)
Sets the localized name of this object layout 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 object layout 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 object layout from the map of locales and localized names, and sets the default locale.
|
void |
setObjectDefinitionId(long objectDefinitionId)
Sets the object definition ID of this object layout.
|
void |
setObjectLayoutId(long objectLayoutId)
Sets the object layout ID of this object layout.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this object layout.
|
void |
setUserId(long userId)
Sets the user ID of this object layout.
|
void |
setUserName(java.lang.String userName)
Sets the user name of this object layout.
|
void |
setUserUuid(java.lang.String userUuid)
Sets the user uuid of this object layout.
|
void |
setUuid(java.lang.String uuid)
Sets the uuid of this object layout.
|
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 layoutlong 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 layout@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 layoutlong getObjectLayoutId()
void setObjectLayoutId(long objectLayoutId)
objectLayoutId
- the object layout ID of this object layoutlong 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 layoutlong 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 layoutjava.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 layout@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 layoutjava.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 layoutjava.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 layoutlong getObjectDefinitionId()
void setObjectDefinitionId(long objectDefinitionId)
objectDefinitionId
- the object definition ID of this object layoutboolean getDefaultObjectLayout()
boolean isDefaultObjectLayout()
true
if this object layout is default object layout.true
if this object layout is default object layout; false
otherwisevoid setDefaultObjectLayout(boolean defaultObjectLayout)
defaultObjectLayout
- the default object layout of this object layoutjava.lang.String getName()
@AutoEscape java.lang.String getName(java.util.Locale locale)
locale
- the locale of the language@AutoEscape java.lang.String getName(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 getName(java.lang.String languageId)
languageId
- the ID of the language@AutoEscape java.lang.String getName(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 getNameCurrentLanguageId()
@AutoEscape java.lang.String getNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String> getNameMap()
void setName(java.lang.String name)
name
- the name of this object layoutvoid setName(java.lang.String name, java.util.Locale locale)
name
- the localized name of this object layoutlocale
- the locale of the languagevoid setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale)
name
- the localized name of this object layoutlocale
- the locale of the languagedefaultLocale
- the default localevoid setNameCurrentLanguageId(java.lang.String languageId)
void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)
nameMap
- the locales and localized names of this object layoutvoid setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Locale defaultLocale)
nameMap
- the locales and localized names of this object layoutdefaultLocale
- the default localejava.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
ObjectLayout cloneWithOriginalValues()
cloneWithOriginalValues
in interface com.liferay.portal.kernel.model.BaseModel<ObjectLayout>