com.liferay.portal.kernel.model

Interface BaseModel<T>

All Superinterfaces:

ClassedModel, java.lang.Cloneable, java.lang.Comparable<T>, java.io.Serializable

All Known Subinterfaces:

Account, AccountModel, Address, AddressModel, AnnouncementsDelivery, AnnouncementsDeliveryModel, AnnouncementsEntry, AnnouncementsEntryModel, AnnouncementsFlag, AnnouncementsFlagModel, AssetCategory, AssetCategoryModel, AssetCategoryProperty, AssetCategoryPropertyModel, AssetEntry, AssetEntryModel, AssetLink, AssetLinkModel, AssetTag, AssetTagModel, AssetTagStats, AssetTagStatsModel, AssetVocabulary, AssetVocabularyModel, BrowserTracker, BrowserTrackerModel, ClassName, ClassNameModel, ClusterGroup, ClusterGroupModel, Company, CompanyModel, Contact, ContactModel, Counter, CounterModel, Country, CountryModel, DLFileEntry, DLFileEntryMetadata, DLFileEntryMetadataModel, DLFileEntryModel, DLFileEntryType, DLFileEntryTypeModel, DLFileShortcut, DLFileShortcutModel, DLFileVersion, DLFileVersionModel, DLFolder, DLFolderModel, Dummy, DummyModel, EmailAddress, EmailAddressModel, ExpandoColumn, ExpandoColumnModel, ExpandoRow, ExpandoRowModel, ExpandoTable, ExpandoTableModel, ExpandoValue, ExpandoValueModel, ExportImportConfiguration, ExportImportConfigurationModel, Group, GroupModel, Image, ImageModel, Layout, LayoutBranch, LayoutBranchModel, LayoutFriendlyURL, LayoutFriendlyURLModel, LayoutModel, LayoutPrototype, LayoutPrototypeModel, LayoutRevision, LayoutRevisionModel, LayoutSet, LayoutSetBranch, LayoutSetBranchModel, LayoutSetModel, LayoutSetPrototype, LayoutSetPrototypeModel, ListType, ListTypeModel, MembershipRequest, MembershipRequestModel, Organization, OrganizationModel, OrgGroupRole, OrgGroupRoleModel, OrgLabor, OrgLaborModel, PasswordPolicy, PasswordPolicyModel, PasswordPolicyRel, PasswordPolicyRelModel, PasswordTracker, PasswordTrackerModel, Phone, PhoneModel, PluginSetting, PluginSettingModel, PortalPreferences, PortalPreferencesModel, Portlet, PortletItem, PortletItemModel, PortletModel, PortletPreferences, PortletPreferencesModel, RatingsEntry, RatingsEntryModel, RatingsStats, RatingsStatsModel, RecentLayoutBranch, RecentLayoutBranchModel, RecentLayoutRevision, RecentLayoutRevisionModel, RecentLayoutSetBranch, RecentLayoutSetBranchModel, Region, RegionModel, Release, ReleaseModel, Repository, RepositoryEntry, RepositoryEntryModel, RepositoryModel, ResourceAction, ResourceActionModel, ResourceBlock, ResourceBlockModel, ResourceBlockPermission, ResourceBlockPermissionModel, ResourcePermission, ResourcePermissionModel, ResourceTypePermission, ResourceTypePermissionModel, Role, RoleModel, ServiceComponent, ServiceComponentModel, SocialActivity, SocialActivityAchievement, SocialActivityAchievementModel, SocialActivityCounter, SocialActivityCounterModel, SocialActivityLimit, SocialActivityLimitModel, SocialActivityModel, SocialActivitySet, SocialActivitySetModel, SocialActivitySetting, SocialActivitySettingModel, SocialRelation, SocialRelationModel, SocialRequest, SocialRequestModel, StagedAssetLink, StagedExpandoColumn, StagedExpandoTable, StagedGroup, StagedGroupedWorkflowDefinitionLink, StagedWorkflowDefinitionLink, Subscription, SubscriptionModel, SystemEvent, SystemEventModel, Team, TeamModel, Ticket, TicketModel, TrashEntry, TrashEntryModel, TrashVersion, TrashVersionModel, User, UserGroup, UserGroupGroupRole, UserGroupGroupRoleModel, UserGroupModel, UserGroupRole, UserGroupRoleModel, UserIdMapper, UserIdMapperModel, UserModel, UserNotificationDelivery, UserNotificationDeliveryModel, UserNotificationEvent, UserNotificationEventModel, UserTracker, UserTrackerModel, UserTrackerPath, UserTrackerPathModel, VirtualHost, VirtualHostModel, WebDAVProps, WebDAVPropsModel, Website, WebsiteModel, WorkflowDefinitionLink, WorkflowDefinitionLinkModel, WorkflowInstanceLink, WorkflowInstanceLinkModel

All Known Implementing Classes:

AccountWrapper, AddressWrapper, AnnouncementsDeliveryWrapper, AnnouncementsEntryWrapper, AnnouncementsFlagWrapper, AssetCategoryPropertyWrapper, AssetCategoryWrapper, AssetEntryWrapper, AssetLinkWrapper, AssetTagStatsWrapper, AssetTagWrapper, AssetVocabularyWrapper, BaseModelImpl, BrowserTrackerWrapper, ClassNameWrapper, ClusterGroupWrapper, CompanyWrapper, ContactWrapper, CounterWrapper, 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, OrgGroupRoleWrapper, OrgLaborWrapper, PasswordPolicyRelWrapper, PasswordPolicyWrapper, PasswordTrackerWrapper, PhoneWrapper, PluginSettingWrapper, PortalPreferencesWrapper, PortletItemWrapper, PortletPreferencesWrapper, PortletWrapper, RatingsEntryWrapper, RatingsStatsWrapper, RecentLayoutBranchWrapper, RecentLayoutRevisionWrapper, RecentLayoutSetBranchWrapper, RegionWrapper, ReleaseWrapper, RepositoryEntryWrapper, RepositoryWrapper, ResourceActionWrapper, ResourceBlockPermissionWrapper, ResourceBlockWrapper, ResourcePermissionWrapper, ResourceTypePermissionWrapper, RoleWrapper, ServiceComponentWrapper, SocialActivityAchievementWrapper, SocialActivityCounterWrapper, SocialActivityLimitWrapper, SocialActivitySettingWrapper, SocialActivitySetWrapper, SocialActivityWrapper, SocialRelationWrapper, SocialRequestWrapper, SubscriptionWrapper, SystemEventWrapper, TeamWrapper, TicketWrapper, TrashEntryWrapper, TrashVersionWrapper, UserGroupGroupRoleWrapper, UserGroupRoleWrapper, UserGroupWrapper, UserIdMapperWrapper, UserNotificationDeliveryWrapper, UserNotificationEventWrapper, UserTrackerPathWrapper, UserTrackerWrapper, UserWrapper, VirtualHostWrapper, VirtualLayout, WebDAVPropsWrapper, WebsiteWrapper, WorkflowDefinitionLinkWrapper, WorkflowInstanceLinkWrapper

@ProviderType
public interface BaseModel<T>
extends ClassedModel, java.lang.Cloneable, java.lang.Comparable<T>, java.io.Serializable

The base interface for all model classes. This interface should never need to be used directly.

Author:

Brian Wing Shun Chan

See Also:

BaseModelImpl

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a shallow clone of this model instance.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
java.util.Map<java.lang.String,java.lang.Object>	getModelAttributes()
java.io.Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEntityCacheEnabled() Returns true if this model's entity cache is enabled.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isFinderCacheEnabled() Returns true if this model's finder cache is enabled.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
void	resetOriginalValues() Reset all original fields to current values.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKeyObj(java.io.Serializable primaryKeyObj) Sets the primary key of this model instance.
CacheModel<T>	toCacheModel() Returns a cache model object for this entity used by entity cache.
T	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
T	toUnescapedModel()
java.lang.String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

clone

java.lang.Object clone()

Creates a shallow clone of this model instance.

Returns:

the shallow clone of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface ClassedModel

Returns:

the expando bridge for this model instance

getModelAttributes

java.util.Map<java.lang.String,java.lang.Object> getModelAttributes()

getPrimaryKeyObj

java.io.Serializable getPrimaryKeyObj()

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface ClassedModel

Returns:

the primary key of this model instance

isCachedModel

boolean isCachedModel()

Returns true if this model instance was retrieved from the entity cache.

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

setCachedModel(boolean)

isEntityCacheEnabled

boolean isEntityCacheEnabled()

Returns true if this model's entity cache is enabled.

Returns:

true if this model's entity cache is enabled; false otherwise

isEscapedModel

boolean isEscapedModel()

Returns true if this model instance is escaped.

Returns:

true if this model instance is escaped; false otherwise

isFinderCacheEnabled

boolean isFinderCacheEnabled()

Returns true if this model's finder cache is enabled.

Returns:

true if this model's finder cache is enabled; false otherwise

isNew

boolean isNew()

Returns true if this model instance does not yet exist in the database.

Returns:

true if this model instance does not yet exist in the database; false otherwise

resetOriginalValues

void resetOriginalValues()

Reset all original fields to current values.

setCachedModel

void setCachedModel(boolean cachedModel)

Sets whether this model instance was retrieved from the entity cache.

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ServiceContext serviceContext)

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes()

setModelAttributes

void setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

setNew

void setNew(boolean n)

Sets whether this model instance does not yet exist in the database.

Parameters:

n - whether this model instance does not yet exist in the database

setPrimaryKeyObj

void setPrimaryKeyObj(java.io.Serializable primaryKeyObj)

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface ClassedModel

Parameters:

primaryKeyObj - the primary key of this model instance

toCacheModel

CacheModel<T> toCacheModel()

Returns a cache model object for this entity used by entity cache.

Returns:

the cache model object

toEscapedModel

T toEscapedModel()

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

T toUnescapedModel()

toXmlString

java.lang.String toXmlString()

Returns the XML representation of this model instance.

Returns:

the XML representation of this model instance