Class BaseModelWrapper<T extends BaseModel<T>>
Object
com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<T>
- All Implemented Interfaces:
BaseModel<T>,ClassedModel,ModelWrapper<T>,Serializable,Cloneable,Comparable<T>
- Direct Known Subclasses:
AddressWrapper,AnnouncementsDeliveryWrapper,AnnouncementsEntryWrapper,AnnouncementsFlagWrapper,AssetCategoryWrapper,AssetEntryWrapper,AssetTagWrapper,AssetVocabularyWrapper,BrowserTrackerWrapper,ClassNameWrapper,CompanyInfoWrapper,CompanyWrapper,ContactWrapper,CounterWrapper,CountryLocalizationWrapper,CountryWrapper,DLFileEntryMetadataWrapper,DLFileEntryTypeWrapper,DLFileEntryWrapper,DLFileShortcutWrapper,DLFileVersionWrapper,DLFolderWrapper,EmailAddressWrapper,ExpandoColumnWrapper,ExpandoRowWrapper,ExpandoTableWrapper,ExpandoValueWrapper,ExportImportConfigurationWrapper,GroupWrapper,ImageWrapper,LayoutBranchWrapper,LayoutFriendlyURLWrapper,LayoutPrototypeWrapper,LayoutRevisionWrapper,LayoutSetBranchWrapper,LayoutSetPrototypeWrapper,LayoutSetWrapper,LayoutWrapper,ListTypeWrapper,MembershipRequestWrapper,OrganizationWrapper,OrgLaborWrapper,PasswordPolicyRelWrapper,PasswordPolicyWrapper,PasswordTrackerWrapper,PhoneWrapper,PluginSettingWrapper,PortalPreferencesWrapper,PortalPreferenceValueWrapper,PortletItemWrapper,PortletPreferencesWrapper,PortletPreferenceValueWrapper,PortletWrapper,RatingsEntryWrapper,RatingsStatsWrapper,RecentLayoutBranchWrapper,RecentLayoutRevisionWrapper,RecentLayoutSetBranchWrapper,RegionLocalizationWrapper,RegionWrapper,ReleaseWrapper,RememberMeTokenWrapper,RepositoryEntryWrapper,RepositoryWrapper,ResourceActionWrapper,ResourcePermissionWrapper,RoleWrapper,ServiceComponentWrapper,SocialActivityAchievementWrapper,SocialActivityCounterWrapper,SocialActivityLimitWrapper,SocialActivitySettingWrapper,SocialActivitySetWrapper,SocialActivityWrapper,SocialRelationWrapper,SocialRequestWrapper,SubscriptionWrapper,SystemEventWrapper,TeamWrapper,TicketWrapper,UserGroupGroupRoleWrapper,UserGroupRoleWrapper,UserGroupWrapper,UserIdMapperWrapper,UserNotificationDeliveryWrapper,UserNotificationEventWrapper,UserTrackerPathWrapper,UserTrackerWrapper,UserWrapper,VirtualHostWrapper,WebDAVPropsWrapper,WebsiteWrapper,WorkflowDefinitionLinkWrapper,WorkflowInstanceLinkWrapper
public abstract class BaseModelWrapper<T extends BaseModel<T>>
extends Object
implements BaseModel<T>, ModelWrapper<T>
- Author:
- Preston Crary
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Creates a shallow clone of this model instance.intbooleanReturns the expando bridge for this model instance.Class<?>Returns the primary key of this model instance.inthashCode()booleanReturnstrueif this model instance was retrieved from the entity cache.booleanDeprecated.As of Athanasius (7.3.x), with no direct replacementbooleanReturnstrueif this model instance is escaped.booleanDeprecated.As of Athanasius (7.3.x), with no direct replacementbooleanisNew()Returnstrueif this model instance does not yet exist in the database.voidReset all original fields to current values.voidsetCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.voidsetExpandoBridgeAttributes(ExpandoBridge expandoBridge) voidsetExpandoBridgeAttributes(BaseModel<?> baseModel) voidsetExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.voidsetNew(boolean n) Sets whether this model instance does not yet exist in the database.voidsetPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.Returns a cache model object for this entity used by entity cache.Returns a copy of this entity as an escaped model instance by wrapping it with anAutoEscapeBeanHandler.toString()protected abstract TMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.liferay.portal.kernel.model.BaseModel
cloneWithOriginalValues, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getModelAttributes, setModelAttributes
-
Field Details
-
model
-
-
Constructor Details
-
BaseModelWrapper
-
-
Method Details
-
clone
Description copied from interface:BaseModelCreates a shallow clone of this model instance. -
compareTo
- Specified by:
compareToin interfaceComparable<T extends BaseModel<T>>
-
equals
-
getExpandoBridge
Description copied from interface:BaseModelReturns the expando bridge for this model instance.- Specified by:
getExpandoBridgein interfaceBaseModel<T extends BaseModel<T>>- Specified by:
getExpandoBridgein interfaceClassedModel- Returns:
- the expando bridge for this model instance
-
getModelClass
- Specified by:
getModelClassin interfaceClassedModel
-
getModelClassName
- Specified by:
getModelClassNamein interfaceClassedModel
-
getPrimaryKeyObj
Description copied from interface:BaseModelReturns the primary key of this model instance.- Specified by:
getPrimaryKeyObjin interfaceBaseModel<T extends BaseModel<T>>- Specified by:
getPrimaryKeyObjin interfaceClassedModel- Returns:
- the primary key of this model instance
-
getWrappedModel
- Specified by:
getWrappedModelin interfaceModelWrapper<T extends BaseModel<T>>
-
hashCode
public int hashCode() -
isCachedModel
public boolean isCachedModel()Description copied from interface:BaseModelReturnstrueif this model instance was retrieved from the entity cache.- Specified by:
isCachedModelin interfaceBaseModel<T extends BaseModel<T>>- Returns:
trueif this model instance was retrieved from the entity cache;falseotherwise- See Also:
-
isEntityCacheEnabled
Deprecated.As of Athanasius (7.3.x), with no direct replacementDescription copied from interface:BaseModelReturnstrueif this model's entity cache is enabled.- Specified by:
isEntityCacheEnabledin interfaceBaseModel<T extends BaseModel<T>>- Returns:
trueif this model's entity cache is enabled;falseotherwise
-
isEscapedModel
public boolean isEscapedModel()Description copied from interface:BaseModelReturnstrueif this model instance is escaped.- Specified by:
isEscapedModelin interfaceBaseModel<T extends BaseModel<T>>- Returns:
trueif this model instance is escaped;falseotherwise
-
isFinderCacheEnabled
Deprecated.As of Athanasius (7.3.x), with no direct replacementDescription copied from interface:BaseModelReturnstrueif this model's finder cache is enabled.- Specified by:
isFinderCacheEnabledin interfaceBaseModel<T extends BaseModel<T>>- Returns:
trueif this model's finder cache is enabled;falseotherwise
-
isNew
public boolean isNew()Description copied from interface:BaseModelReturnstrueif this model instance does not yet exist in the database. -
resetOriginalValues
public void resetOriginalValues()Description copied from interface:BaseModelReset all original fields to current values.- Specified by:
resetOriginalValuesin interfaceBaseModel<T extends BaseModel<T>>
-
setCachedModel
public void setCachedModel(boolean cachedModel) Description copied from interface:BaseModelSets whether this model instance was retrieved from the entity cache.- Specified by:
setCachedModelin interfaceBaseModel<T extends BaseModel<T>>- Parameters:
cachedModel- whether this model instance was retrieved from the entity cache- See Also:
-
setExpandoBridgeAttributes
- Specified by:
setExpandoBridgeAttributesin interfaceBaseModel<T extends BaseModel<T>>
-
setExpandoBridgeAttributes
- Specified by:
setExpandoBridgeAttributesin interfaceBaseModel<T extends BaseModel<T>>
-
setExpandoBridgeAttributes
Description copied from interface:BaseModelSets the expando bridge attributes for this model instance to the attributes stored in the service context.- Specified by:
setExpandoBridgeAttributesin interfaceBaseModel<T extends BaseModel<T>>- Parameters:
serviceContext- the service context to be applied- See Also:
-
setNew
public void setNew(boolean n) Description copied from interface:BaseModelSets whether this model instance does not yet exist in the database. -
setPrimaryKeyObj
Description copied from interface:BaseModelSets the primary key of this model instance.- Specified by:
setPrimaryKeyObjin interfaceBaseModel<T extends BaseModel<T>>- Specified by:
setPrimaryKeyObjin interfaceClassedModel- Parameters:
primaryKeyObj- the primary key of this model instance
-
toCacheModel
Description copied from interface:BaseModelReturns a cache model object for this entity used by entity cache.- Specified by:
toCacheModelin interfaceBaseModel<T extends BaseModel<T>>- Returns:
- the cache model object
-
toEscapedModel
Description copied from interface:BaseModelReturns a copy of this entity as an escaped model instance by wrapping it with anAutoEscapeBeanHandler.- Specified by:
toEscapedModelin interfaceBaseModel<T extends BaseModel<T>>- Returns:
- the escaped model instance
- See Also:
-
toString
-
toUnescapedModel
- Specified by:
toUnescapedModelin interfaceBaseModel<T extends BaseModel<T>>
-
wrap
-