Package com.liferay.object.model
Interface ObjectLayoutModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<ObjectLayout>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<ObjectLayout>
,com.liferay.portal.kernel.model.LocalizedModel
,com.liferay.portal.kernel.model.MVCCModel
,Serializable
,com.liferay.portal.kernel.model.ShardedModel
,com.liferay.portal.kernel.model.StagedAuditedModel
,com.liferay.portal.kernel.model.StagedModel
- All Known Subinterfaces:
ObjectLayout
- All Known Implementing Classes:
ObjectLayoutWrapper
@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
The base model interface for the ObjectLayout service. Represents a row in the "ObjectLayout" database table, with each column mapped to a property of this class.
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
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]
long
Returns the company ID of this object layout.Returns the create date of this object layout.boolean
Returns the default object layout of this object layout.Returns the modified date of this object layout.long
Returns the mvcc version of this object layout.getName()
Returns the name of this object layout.Returns the localized name of this object layout in the language.Returns the localized name of this object layout in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this object layout in the language.Returns the localized name of this object layout in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized names of this object layout.long
Returns the object definition ID of this object layout.long
Returns the object layout ID of this object layout.long
Returns the primary key of this object layout.long
Returns the user ID of this object layout.Returns the user name of this object layout.Returns the user uuid of this object layout.getUuid()
Returns the uuid of this object layout.boolean
Returnstrue
if this object layout is default object layout.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setCompanyId
(long companyId) Sets the company ID of this object layout.void
setCreateDate
(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
(Date modifiedDate) Sets the modified date of this object layout.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this object layout.void
Sets the name of this object layout.void
Sets the localized name of this object layout in the language.void
Sets the localized name of this object layout in the language, and sets the default locale.void
setNameCurrentLanguageId
(String languageId) void
setNameMap
(Map<Locale, String> nameMap) Sets the localized names of this object layout from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, 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
(String userName) Sets the user name of this object layout.void
setUserUuid
(String userUuid) Sets the user uuid of this object layout.void
Sets the uuid of this object layout.default String
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
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this object layout.- Returns:
- the primary key of this object layout
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this object layout.- Parameters:
primaryKey
- the primary key of this object layout
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this object layout.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this object layout
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this object layout.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this object layout
-
getUuid
Returns the uuid of this object layout.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this object layout
-
setUuid
Sets the uuid of this object layout.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this object layout
-
getObjectLayoutId
long getObjectLayoutId()Returns the object layout ID of this object layout.- Returns:
- the object layout ID of this object layout
-
setObjectLayoutId
void setObjectLayoutId(long objectLayoutId) Sets the object layout ID of this object layout.- Parameters:
objectLayoutId
- the object layout ID of this object layout
-
getCompanyId
long getCompanyId()Returns the company ID of this object layout.- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the company ID of this object layout
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this object layout.- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
companyId
- the company ID of this object layout
-
getUserId
long getUserId()Returns the user ID of this object layout.- Specified by:
getUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user ID of this object layout
-
setUserId
void setUserId(long userId) Sets the user ID of this object layout.- Specified by:
setUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this object layout
-
getUserUuid
String getUserUuid()Returns the user uuid of this object layout.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this object layout
-
setUserUuid
Sets the user uuid of this object layout.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this object layout
-
getUserName
Returns the user name of this object layout.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this object layout
-
setUserName
Sets the user name of this object layout.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this object layout
-
getCreateDate
Date getCreateDate()Returns the create date of this object layout.- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the create date of this object layout
-
setCreateDate
Sets the create date of this object layout.- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
createDate
- the create date of this object layout
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this object layout.- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the modified date of this object layout
-
setModifiedDate
Sets the modified date of this object layout.- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
modifiedDate
- the modified date of this object layout
-
getObjectDefinitionId
long getObjectDefinitionId()Returns the object definition ID of this object layout.- Returns:
- the object definition ID of this object layout
-
setObjectDefinitionId
void setObjectDefinitionId(long objectDefinitionId) Sets the object definition ID of this object layout.- Parameters:
objectDefinitionId
- the object definition ID of this object layout
-
getDefaultObjectLayout
boolean getDefaultObjectLayout()Returns the default object layout of this object layout.- Returns:
- the default object layout of this object layout
-
isDefaultObjectLayout
boolean isDefaultObjectLayout()Returnstrue
if this object layout is default object layout.- Returns:
true
if this object layout is default object layout;false
otherwise
-
setDefaultObjectLayout
void setDefaultObjectLayout(boolean defaultObjectLayout) Sets whether this object layout is default object layout.- Parameters:
defaultObjectLayout
- the default object layout of this object layout
-
getName
String getName()Returns the name of this object layout.- Returns:
- the name of this object layout
-
getName
Returns the localized name of this object layout 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 object layout
-
getName
Returns the localized name of this object layout in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this object layout. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this object layout 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 object layout
-
getName
Returns the localized name of this object layout in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this object layout
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this object layout.- Returns:
- the locales and localized names of this object layout
-
setName
Sets the name of this object layout.- Parameters:
name
- the name of this object layout
-
setName
Sets the localized name of this object layout in the language.- Parameters:
name
- the localized name of this object layoutlocale
- the locale of the language
-
setName
Sets the localized name of this object layout in the language, and sets the default locale.- Parameters:
name
- the localized name of this object layoutlocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this object layout from the map of locales and localized names.- Parameters:
nameMap
- the locales and localized names of this object layout
-
setNameMap
Sets the localized names of this object layout from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap
- the locales and localized names of this object layoutdefaultLocale
- the default locale
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIds
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException - Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
ObjectLayout cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<ObjectLayout>
-
toXmlString
-