Package com.liferay.object.model
Interface ObjectLayoutBoxModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<ObjectLayoutBox>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<ObjectLayoutBox>
,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:
ObjectLayoutBox
- All Known Implementing Classes:
ObjectLayoutBoxWrapper
@ProviderType
public interface ObjectLayoutBoxModel
extends com.liferay.portal.kernel.model.BaseModel<ObjectLayoutBox>, 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 ObjectLayoutBox service. Represents a row in the "ObjectLayoutBox" database table, with each column mapped to a property of this class.
This interface and its corresponding implementation com.liferay.object.model.impl.ObjectLayoutBoxModelImpl
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.ObjectLayoutBoxImpl
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]
boolean
Returns the collapsable of this object layout box.long
Returns the company ID of this object layout box.Returns the create date of this object layout box.Returns the modified date of this object layout box.long
Returns the mvcc version of this object layout box.getName()
Returns the name of this object layout box.Returns the localized name of this object layout box in the language.Returns the localized name of this object layout box in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this object layout box in the language.Returns the localized name of this object layout box 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 box.long
Returns the object layout box ID of this object layout box.long
Returns the object layout tab ID of this object layout box.long
Returns the primary key of this object layout box.int
Returns the priority of this object layout box.getType()
Returns the type of this object layout box.long
Returns the user ID of this object layout box.Returns the user name of this object layout box.Returns the user uuid of this object layout box.getUuid()
Returns the uuid of this object layout box.boolean
Returnstrue
if this object layout box is collapsable.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setCollapsable
(boolean collapsable) Sets whether this object layout box is collapsable.void
setCompanyId
(long companyId) Sets the company ID of this object layout box.void
setCreateDate
(Date createDate) Sets the create date of this object layout box.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this object layout box.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this object layout box.void
Sets the name of this object layout box.void
Sets the localized name of this object layout box in the language.void
Sets the localized name of this object layout box 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 box from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, Locale defaultLocale) Sets the localized names of this object layout box from the map of locales and localized names, and sets the default locale.void
setObjectLayoutBoxId
(long objectLayoutBoxId) Sets the object layout box ID of this object layout box.void
setObjectLayoutTabId
(long objectLayoutTabId) Sets the object layout tab ID of this object layout box.void
setPrimaryKey
(long primaryKey) Sets the primary key of this object layout box.void
setPriority
(int priority) Sets the priority of this object layout box.void
Sets the type of this object layout box.void
setUserId
(long userId) Sets the user ID of this object layout box.void
setUserName
(String userName) Sets the user name of this object layout box.void
setUserUuid
(String userUuid) Sets the user uuid of this object layout box.void
Sets the uuid of this object layout box.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 box.- Returns:
- the primary key of this object layout box
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this object layout box.- Parameters:
primaryKey
- the primary key of this object layout box
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this object layout box.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this object layout box
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this object layout box.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this object layout box
-
getUuid
Returns the uuid of this object layout box.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this object layout box
-
setUuid
Sets the uuid of this object layout box.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this object layout box
-
getObjectLayoutBoxId
long getObjectLayoutBoxId()Returns the object layout box ID of this object layout box.- Returns:
- the object layout box ID of this object layout box
-
setObjectLayoutBoxId
void setObjectLayoutBoxId(long objectLayoutBoxId) Sets the object layout box ID of this object layout box.- Parameters:
objectLayoutBoxId
- the object layout box ID of this object layout box
-
getCompanyId
long getCompanyId()Returns the company ID of this object layout box.- 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 box
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this object layout box.- 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 box
-
getUserId
long getUserId()Returns the user ID of this object layout box.- Specified by:
getUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user ID of this object layout box
-
setUserId
void setUserId(long userId) Sets the user ID of this object layout box.- Specified by:
setUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this object layout box
-
getUserUuid
String getUserUuid()Returns the user uuid of this object layout box.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this object layout box
-
setUserUuid
Sets the user uuid of this object layout box.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this object layout box
-
getUserName
Returns the user name of this object layout box.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this object layout box
-
setUserName
Sets the user name of this object layout box.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this object layout box
-
getCreateDate
Date getCreateDate()Returns the create date of this object layout box.- 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 box
-
setCreateDate
Sets the create date of this object layout box.- 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 box
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this object layout box.- 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 box
-
setModifiedDate
Sets the modified date of this object layout box.- 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 box
-
getObjectLayoutTabId
long getObjectLayoutTabId()Returns the object layout tab ID of this object layout box.- Returns:
- the object layout tab ID of this object layout box
-
setObjectLayoutTabId
void setObjectLayoutTabId(long objectLayoutTabId) Sets the object layout tab ID of this object layout box.- Parameters:
objectLayoutTabId
- the object layout tab ID of this object layout box
-
getCollapsable
boolean getCollapsable()Returns the collapsable of this object layout box.- Returns:
- the collapsable of this object layout box
-
isCollapsable
boolean isCollapsable()Returnstrue
if this object layout box is collapsable.- Returns:
true
if this object layout box is collapsable;false
otherwise
-
setCollapsable
void setCollapsable(boolean collapsable) Sets whether this object layout box is collapsable.- Parameters:
collapsable
- the collapsable of this object layout box
-
getName
String getName()Returns the name of this object layout box.- Returns:
- the name of this object layout box
-
getName
Returns the localized name of this object layout box 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 box
-
getName
Returns the localized name of this object layout box 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 box. 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 box 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 box
-
getName
Returns the localized name of this object layout box 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 box
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this object layout box.- Returns:
- the locales and localized names of this object layout box
-
setName
Sets the name of this object layout box.- Parameters:
name
- the name of this object layout box
-
setName
Sets the localized name of this object layout box in the language.- Parameters:
name
- the localized name of this object layout boxlocale
- the locale of the language
-
setName
Sets the localized name of this object layout box in the language, and sets the default locale.- Parameters:
name
- the localized name of this object layout boxlocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this object layout box from the map of locales and localized names.- Parameters:
nameMap
- the locales and localized names of this object layout box
-
setNameMap
Sets the localized names of this object layout box from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap
- the locales and localized names of this object layout boxdefaultLocale
- the default locale
-
getPriority
int getPriority()Returns the priority of this object layout box.- Returns:
- the priority of this object layout box
-
setPriority
void setPriority(int priority) Sets the priority of this object layout box.- Parameters:
priority
- the priority of this object layout box
-
getType
Returns the type of this object layout box.- Returns:
- the type of this object layout box
-
setType
Sets the type of this object layout box.- Parameters:
type
- the type of this object layout box
-
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
ObjectLayoutBox cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<ObjectLayoutBox>
-
toXmlString
-