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.int
boolean
Returns the expando bridge for this model instance.Class<?>
Returns the primary key of this model instance.int
hashCode()
boolean
Returnstrue
if this model instance was retrieved from the entity cache.boolean
Deprecated.As of Athanasius (7.3.x), with no direct replacementboolean
Returnstrue
if this model instance is escaped.boolean
Deprecated.As of Athanasius (7.3.x), with no direct replacementboolean
isNew()
Returnstrue
if this model instance does not yet exist in the database.void
Reset all original fields to current values.void
setCachedModel
(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.void
setExpandoBridgeAttributes
(ExpandoBridge expandoBridge) void
setExpandoBridgeAttributes
(BaseModel<?> baseModel) void
setExpandoBridgeAttributes
(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.void
setNew
(boolean n) Sets whether this model instance does not yet exist in the database.void
setPrimaryKeyObj
(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 T
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods 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:BaseModel
Creates a shallow clone of this model instance. -
compareTo
- Specified by:
compareTo
in interfaceComparable<T extends BaseModel<T>>
-
equals
-
getExpandoBridge
Description copied from interface:BaseModel
Returns the expando bridge for this model instance.- Specified by:
getExpandoBridge
in interfaceBaseModel<T extends BaseModel<T>>
- Specified by:
getExpandoBridge
in interfaceClassedModel
- Returns:
- the expando bridge for this model instance
-
getModelClass
- Specified by:
getModelClass
in interfaceClassedModel
-
getModelClassName
- Specified by:
getModelClassName
in interfaceClassedModel
-
getPrimaryKeyObj
Description copied from interface:BaseModel
Returns the primary key of this model instance.- Specified by:
getPrimaryKeyObj
in interfaceBaseModel<T extends BaseModel<T>>
- Specified by:
getPrimaryKeyObj
in interfaceClassedModel
- Returns:
- the primary key of this model instance
-
getWrappedModel
- Specified by:
getWrappedModel
in interfaceModelWrapper<T extends BaseModel<T>>
-
hashCode
public int hashCode() -
isCachedModel
public boolean isCachedModel()Description copied from interface:BaseModel
Returnstrue
if this model instance was retrieved from the entity cache.- Specified by:
isCachedModel
in interfaceBaseModel<T extends BaseModel<T>>
- Returns:
true
if this model instance was retrieved from the entity cache;false
otherwise- See Also:
-
isEntityCacheEnabled
Deprecated.As of Athanasius (7.3.x), with no direct replacementDescription copied from interface:BaseModel
Returnstrue
if this model's entity cache is enabled.- Specified by:
isEntityCacheEnabled
in interfaceBaseModel<T extends BaseModel<T>>
- Returns:
true
if this model's entity cache is enabled;false
otherwise
-
isEscapedModel
public boolean isEscapedModel()Description copied from interface:BaseModel
Returnstrue
if this model instance is escaped.- Specified by:
isEscapedModel
in interfaceBaseModel<T extends BaseModel<T>>
- Returns:
true
if this model instance is escaped;false
otherwise
-
isFinderCacheEnabled
Deprecated.As of Athanasius (7.3.x), with no direct replacementDescription copied from interface:BaseModel
Returnstrue
if this model's finder cache is enabled.- Specified by:
isFinderCacheEnabled
in interfaceBaseModel<T extends BaseModel<T>>
- Returns:
true
if this model's finder cache is enabled;false
otherwise
-
isNew
public boolean isNew()Description copied from interface:BaseModel
Returnstrue
if this model instance does not yet exist in the database. -
resetOriginalValues
public void resetOriginalValues()Description copied from interface:BaseModel
Reset all original fields to current values.- Specified by:
resetOriginalValues
in interfaceBaseModel<T extends BaseModel<T>>
-
setCachedModel
public void setCachedModel(boolean cachedModel) Description copied from interface:BaseModel
Sets whether this model instance was retrieved from the entity cache.- Specified by:
setCachedModel
in interfaceBaseModel<T extends BaseModel<T>>
- Parameters:
cachedModel
- whether this model instance was retrieved from the entity cache- See Also:
-
setExpandoBridgeAttributes
- Specified by:
setExpandoBridgeAttributes
in interfaceBaseModel<T extends BaseModel<T>>
-
setExpandoBridgeAttributes
- Specified by:
setExpandoBridgeAttributes
in interfaceBaseModel<T extends BaseModel<T>>
-
setExpandoBridgeAttributes
Description copied from interface:BaseModel
Sets the expando bridge attributes for this model instance to the attributes stored in the service context.- Specified by:
setExpandoBridgeAttributes
in 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:BaseModel
Sets whether this model instance does not yet exist in the database. -
setPrimaryKeyObj
Description copied from interface:BaseModel
Sets the primary key of this model instance.- Specified by:
setPrimaryKeyObj
in interfaceBaseModel<T extends BaseModel<T>>
- Specified by:
setPrimaryKeyObj
in interfaceClassedModel
- Parameters:
primaryKeyObj
- the primary key of this model instance
-
toCacheModel
Description copied from interface:BaseModel
Returns a cache model object for this entity used by entity cache.- Specified by:
toCacheModel
in interfaceBaseModel<T extends BaseModel<T>>
- Returns:
- the cache model object
-
toEscapedModel
Description copied from interface:BaseModel
Returns a copy of this entity as an escaped model instance by wrapping it with anAutoEscapeBeanHandler
.- Specified by:
toEscapedModel
in interfaceBaseModel<T extends BaseModel<T>>
- Returns:
- the escaped model instance
- See Also:
-
toString
-
toUnescapedModel
- Specified by:
toUnescapedModel
in interfaceBaseModel<T extends BaseModel<T>>
-
wrap
-