com.liferay.portal.model
Interface BaseModel<T>

All Superinterfaces:

Cloneable, Comparable<T>, Serializable

All Known Subinterfaces:

Account, AccountModel, Address, AddressModel, AnnouncementsDelivery, AnnouncementsDeliveryModel, AnnouncementsEntry, AnnouncementsEntryModel, AnnouncementsFlag, AnnouncementsFlagModel, AssetCategory, AssetCategoryModel, AssetCategoryProperty, AssetCategoryPropertyModel, AssetEntry, AssetEntryModel, AssetLink, AssetLinkModel, AssetTag, AssetTagModel, AssetTagProperty, AssetTagPropertyModel, AssetTagStats, AssetTagStatsModel, AssetVocabulary, AssetVocabularyModel, BlogsEntry, BlogsEntryModel, BlogsStatsUser, BlogsStatsUserModel, BookmarksEntry, BookmarksEntryModel, BookmarksFolder, BookmarksFolderModel, BrowserTracker, BrowserTrackerModel, CalEvent, CalEventModel, ClassName, ClassNameModel, ClusterGroup, ClusterGroupModel, Company, CompanyModel, Contact, ContactModel, Counter, CounterModel, Country, CountryModel, DLFileEntry, DLFileEntryModel, DLFileRank, DLFileRankModel, DLFileShortcut, DLFileShortcutModel, DLFileVersion, DLFileVersionModel, DLFolder, DLFolderModel, Dummy, DummyModel, EmailAddress, EmailAddressModel, ExpandoColumn, ExpandoColumnModel, ExpandoRow, ExpandoRowModel, ExpandoTable, ExpandoTableModel, ExpandoValue, ExpandoValueModel, Group, GroupModel, IGFolder, IGFolderModel, IGImage, IGImageModel, Image, ImageModel, JournalArticle, JournalArticleImage, JournalArticleImageModel, JournalArticleModel, JournalArticleResource, JournalArticleResourceModel, JournalContentSearch, JournalContentSearchModel, JournalFeed, JournalFeedModel, JournalStructure, JournalStructureModel, JournalTemplate, JournalTemplateModel, Layout, LayoutModel, LayoutPrototype, LayoutPrototypeModel, LayoutSet, LayoutSetModel, LayoutSetPrototype, LayoutSetPrototypeModel, ListType, ListTypeModel, Lock, LockModel, MBBan, MBBanModel, MBCategory, MBCategoryModel, MBDiscussion, MBDiscussionModel, MBMailingList, MBMailingListModel, MBMessage, MBMessageFlag, MBMessageFlagModel, MBMessageModel, MBStatsUser, MBStatsUserModel, MBThread, MBThreadModel, MembershipRequest, MembershipRequestModel, Organization, OrganizationModel, OrgGroupPermission, OrgGroupPermissionModel, OrgGroupRole, OrgGroupRoleModel, OrgLabor, OrgLaborModel, PasswordPolicy, PasswordPolicyModel, PasswordPolicyRel, PasswordPolicyRelModel, PasswordTracker, PasswordTrackerModel, Permission, PermissionModel, Phone, PhoneModel, PluginSetting, PluginSettingModel, PollsChoice, PollsChoiceModel, PollsQuestion, PollsQuestionModel, PollsVote, PollsVoteModel, Portlet, PortletItem, PortletItemModel, PortletModel, PortletPreferences, PortletPreferencesModel, RatingsEntry, RatingsEntryModel, RatingsStats, RatingsStatsModel, Region, RegionModel, Release, ReleaseModel, Resource, ResourceAction, ResourceActionModel, ResourceCode, ResourceCodeModel, ResourceModel, ResourcePermission, ResourcePermissionModel, Role, RoleModel, SCFrameworkVersion, SCFrameworkVersionModel, SCLicense, SCLicenseModel, SCProductEntry, SCProductEntryModel, SCProductScreenshot, SCProductScreenshotModel, SCProductVersion, SCProductVersionModel, ServiceComponent, ServiceComponentModel, Shard, ShardModel, ShoppingCart, ShoppingCartModel, ShoppingCategory, ShoppingCategoryModel, ShoppingCoupon, ShoppingCouponModel, ShoppingItem, ShoppingItemField, ShoppingItemFieldModel, ShoppingItemModel, ShoppingItemPrice, ShoppingItemPriceModel, ShoppingOrder, ShoppingOrderItem, ShoppingOrderItemModel, ShoppingOrderModel, SocialActivity, SocialActivityModel, SocialEquityAssetEntry, SocialEquityAssetEntryModel, SocialEquityHistory, SocialEquityHistoryModel, SocialEquityLog, SocialEquityLogModel, SocialEquitySetting, SocialEquitySettingModel, SocialEquityUser, SocialEquityUserModel, SocialRelation, SocialRelationModel, SocialRequest, SocialRequestModel, Subscription, SubscriptionModel, TasksProposal, TasksProposalModel, TasksReview, TasksReviewModel, Team, TeamModel, Ticket, TicketModel, User, UserGroup, UserGroupGroupRole, UserGroupGroupRoleModel, UserGroupModel, UserGroupRole, UserGroupRoleModel, UserIdMapper, UserIdMapperModel, UserModel, UserTracker, UserTrackerModel, UserTrackerPath, UserTrackerPathModel, WebDAVProps, WebDAVPropsModel, Website, WebsiteModel, WikiNode, WikiNodeModel, WikiPage, WikiPageModel, WikiPageResource, WikiPageResourceModel, WorkflowDefinitionLink, WorkflowDefinitionLinkModel, WorkflowInstanceLink, WorkflowInstanceLinkModel

All Known Implementing Classes:

AccountImpl, AccountModelImpl, AccountWrapper, AddressImpl, AddressModelImpl, AddressWrapper, AnnouncementsDeliveryImpl, AnnouncementsDeliveryModelImpl, AnnouncementsDeliveryWrapper, AnnouncementsEntryImpl, AnnouncementsEntryModelImpl, AnnouncementsEntryWrapper, AnnouncementsFlagImpl, AnnouncementsFlagModelImpl, AnnouncementsFlagWrapper, AssetCategoryImpl, AssetCategoryModelImpl, AssetCategoryPropertyImpl, AssetCategoryPropertyModelImpl, AssetCategoryPropertyWrapper, AssetCategoryWrapper, AssetEntryImpl, AssetEntryModelImpl, AssetEntryWrapper, AssetLinkImpl, AssetLinkModelImpl, AssetLinkWrapper, AssetTagImpl, AssetTagModelImpl, AssetTagPropertyImpl, AssetTagPropertyModelImpl, AssetTagPropertyWrapper, AssetTagStatsImpl, AssetTagStatsModelImpl, AssetTagStatsWrapper, AssetTagWrapper, AssetVocabularyImpl, AssetVocabularyModelImpl, AssetVocabularyWrapper, BaseModelImpl, BlogsEntryImpl, BlogsEntryModelImpl, BlogsEntryWrapper, BlogsStatsUserImpl, BlogsStatsUserModelImpl, BlogsStatsUserWrapper, BookmarksEntryImpl, BookmarksEntryModelImpl, BookmarksEntryWrapper, BookmarksFolderImpl, BookmarksFolderModelImpl, BookmarksFolderWrapper, BrowserTrackerImpl, BrowserTrackerModelImpl, BrowserTrackerWrapper, CalEventImpl, CalEventModelImpl, CalEventWrapper, ClassNameImpl, ClassNameModelImpl, ClassNameWrapper, ClusterGroupImpl, ClusterGroupModelImpl, ClusterGroupWrapper, CompanyImpl, CompanyModelImpl, CompanyWrapper, ContactImpl, ContactModelImpl, ContactWrapper, CounterImpl, CounterModelImpl, CounterWrapper, CountryImpl, CountryModelImpl, CountryWrapper, DLFileEntryImpl, DLFileEntryModelImpl, DLFileEntryWrapper, DLFileRankImpl, DLFileRankModelImpl, DLFileRankWrapper, DLFileShortcutImpl, DLFileShortcutModelImpl, DLFileShortcutWrapper, DLFileVersionImpl, DLFileVersionModelImpl, DLFileVersionWrapper, DLFolderImpl, DLFolderModelImpl, DLFolderWrapper, DummyImpl, EmailAddressImpl, EmailAddressModelImpl, EmailAddressWrapper, ExpandoColumnImpl, ExpandoColumnModelImpl, ExpandoColumnWrapper, ExpandoRowImpl, ExpandoRowModelImpl, ExpandoRowWrapper, ExpandoTableImpl, ExpandoTableModelImpl, ExpandoTableWrapper, ExpandoValueImpl, ExpandoValueModelImpl, ExpandoValueWrapper, GroupImpl, GroupModelImpl, GroupWrapper, IGFolderImpl, IGFolderModelImpl, IGFolderWrapper, IGImageImpl, IGImageModelImpl, IGImageWrapper, ImageImpl, ImageModelImpl, ImageWrapper, JournalArticleImageImpl, JournalArticleImageModelImpl, JournalArticleImageWrapper, JournalArticleImpl, JournalArticleModelImpl, JournalArticleResourceImpl, JournalArticleResourceModelImpl, JournalArticleResourceWrapper, JournalArticleWrapper, JournalContentSearchImpl, JournalContentSearchModelImpl, JournalContentSearchWrapper, JournalFeedImpl, JournalFeedModelImpl, JournalFeedWrapper, JournalStructureImpl, JournalStructureModelImpl, JournalStructureWrapper, JournalTemplateImpl, JournalTemplateModelImpl, JournalTemplateWrapper, LayoutImpl, LayoutModelImpl, LayoutPrototypeImpl, LayoutPrototypeModelImpl, LayoutPrototypeWrapper, LayoutSetImpl, LayoutSetModelImpl, LayoutSetPrototypeImpl, LayoutSetPrototypeModelImpl, LayoutSetPrototypeWrapper, LayoutSetWrapper, LayoutWrapper, ListTypeImpl, ListTypeModelImpl, ListTypeWrapper, LockImpl, LockModelImpl, LockWrapper, MBBanImpl, MBBanModelImpl, MBBanWrapper, MBCategoryImpl, MBCategoryModelImpl, MBCategoryWrapper, MBDiscussionImpl, MBDiscussionModelImpl, MBDiscussionWrapper, MBMailingListImpl, MBMailingListModelImpl, MBMailingListWrapper, MBMessageFlagImpl, MBMessageFlagModelImpl, MBMessageFlagWrapper, MBMessageImpl, MBMessageModelImpl, MBMessageWrapper, MBStatsUserImpl, MBStatsUserModelImpl, MBStatsUserWrapper, MBThreadImpl, MBThreadModelImpl, MBThreadWrapper, MembershipRequestImpl, MembershipRequestModelImpl, MembershipRequestWrapper, OrganizationImpl, OrganizationModelImpl, OrganizationWrapper, OrgGroupPermissionImpl, OrgGroupPermissionModelImpl, OrgGroupPermissionWrapper, OrgGroupRoleImpl, OrgGroupRoleModelImpl, OrgGroupRoleWrapper, OrgLaborImpl, OrgLaborModelImpl, OrgLaborWrapper, PasswordPolicyImpl, PasswordPolicyModelImpl, PasswordPolicyRelImpl, PasswordPolicyRelModelImpl, PasswordPolicyRelWrapper, PasswordPolicyWrapper, PasswordTrackerImpl, PasswordTrackerModelImpl, PasswordTrackerWrapper, PermissionImpl, PermissionModelImpl, PermissionWrapper, PhoneImpl, PhoneModelImpl, PhoneWrapper, PluginSettingImpl, PluginSettingModelImpl, PluginSettingWrapper, PollsChoiceImpl, PollsChoiceModelImpl, PollsChoiceWrapper, PollsQuestionImpl, PollsQuestionModelImpl, PollsQuestionWrapper, PollsVoteImpl, PollsVoteModelImpl, PollsVoteWrapper, PortletImpl, PortletItemImpl, PortletItemModelImpl, PortletItemWrapper, PortletModelImpl, PortletPreferencesImpl, PortletPreferencesModelImpl, PortletPreferencesWrapper, PortletWrapper, RatingsEntryImpl, RatingsEntryModelImpl, RatingsEntryWrapper, RatingsStatsImpl, RatingsStatsModelImpl, RatingsStatsWrapper, RegionImpl, RegionModelImpl, RegionWrapper, ReleaseImpl, ReleaseModelImpl, ReleaseWrapper, ResourceActionImpl, ResourceActionModelImpl, ResourceActionWrapper, ResourceCodeImpl, ResourceCodeModelImpl, ResourceCodeWrapper, ResourceImpl, ResourceModelImpl, ResourcePermissionImpl, ResourcePermissionModelImpl, ResourcePermissionWrapper, ResourceWrapper, RoleImpl, RoleModelImpl, RoleWrapper, SCFrameworkVersionImpl, SCFrameworkVersionModelImpl, SCFrameworkVersionWrapper, SCLicenseImpl, SCLicenseModelImpl, SCLicenseWrapper, SCProductEntryImpl, SCProductEntryModelImpl, SCProductEntryWrapper, SCProductScreenshotImpl, SCProductScreenshotModelImpl, SCProductScreenshotWrapper, SCProductVersionImpl, SCProductVersionModelImpl, SCProductVersionWrapper, ServiceComponentImpl, ServiceComponentModelImpl, ServiceComponentWrapper, ShardImpl, ShardModelImpl, ShardWrapper, ShoppingCartImpl, ShoppingCartModelImpl, ShoppingCartWrapper, ShoppingCategoryImpl, ShoppingCategoryModelImpl, ShoppingCategoryWrapper, ShoppingCouponImpl, ShoppingCouponModelImpl, ShoppingCouponWrapper, ShoppingItemFieldImpl, ShoppingItemFieldModelImpl, ShoppingItemFieldWrapper, ShoppingItemImpl, ShoppingItemModelImpl, ShoppingItemPriceImpl, ShoppingItemPriceModelImpl, ShoppingItemPriceWrapper, ShoppingItemWrapper, ShoppingOrderImpl, ShoppingOrderItemImpl, ShoppingOrderItemModelImpl, ShoppingOrderItemWrapper, ShoppingOrderModelImpl, ShoppingOrderWrapper, SocialActivityImpl, SocialActivityModelImpl, SocialActivityWrapper, SocialEquityAssetEntryImpl, SocialEquityAssetEntryModelImpl, SocialEquityAssetEntryWrapper, SocialEquityHistoryImpl, SocialEquityHistoryModelImpl, SocialEquityHistoryWrapper, SocialEquityLogImpl, SocialEquityLogModelImpl, SocialEquityLogWrapper, SocialEquitySettingImpl, SocialEquitySettingModelImpl, SocialEquitySettingWrapper, SocialEquityUserImpl, SocialEquityUserModelImpl, SocialEquityUserWrapper, SocialRelationImpl, SocialRelationModelImpl, SocialRelationWrapper, SocialRequestImpl, SocialRequestModelImpl, SocialRequestWrapper, SubscriptionImpl, SubscriptionModelImpl, SubscriptionWrapper, TasksProposalImpl, TasksProposalModelImpl, TasksProposalWrapper, TasksReviewImpl, TasksReviewModelImpl, TasksReviewWrapper, TeamImpl, TeamModelImpl, TeamWrapper, TicketImpl, TicketModelImpl, TicketWrapper, UserGroupGroupRoleImpl, UserGroupGroupRoleModelImpl, UserGroupGroupRoleWrapper, UserGroupImpl, UserGroupModelImpl, UserGroupRoleImpl, UserGroupRoleModelImpl, UserGroupRoleWrapper, UserGroupWrapper, UserIdMapperImpl, UserIdMapperModelImpl, UserIdMapperWrapper, UserImpl, UserModelImpl, UserTrackerImpl, UserTrackerModelImpl, UserTrackerPathImpl, UserTrackerPathModelImpl, UserTrackerPathWrapper, UserTrackerWrapper, UserWrapper, WebDAVPropsImpl, WebDAVPropsModelImpl, WebDAVPropsWrapper, WebsiteImpl, WebsiteModelImpl, WebsiteWrapper, WikiNodeImpl, WikiNodeModelImpl, WikiNodeWrapper, WikiPageImpl, WikiPageModelImpl, WikiPageResourceImpl, WikiPageResourceModelImpl, WikiPageResourceWrapper, WikiPageWrapper, WorkflowDefinitionLinkImpl, WorkflowDefinitionLinkModelImpl, WorkflowDefinitionLinkWrapper, WorkflowInstanceLinkImpl, WorkflowInstanceLinkModelImpl, WorkflowInstanceLinkWrapper

public interface BaseModel<T>
extends Cloneable, Comparable<T>, Serializable

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

See Also:

BaseModelImpl

Method Summary

Object	clone() Creates a shallow clone of this model instance.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isNew() Determines if this model instance does not yet exist in the database.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setEscapedModel(boolean escapedModel) Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
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.
String	toXmlString() Gets the XML representation of this model instance.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isNew

boolean isNew()

Determines 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

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

isCachedModel

boolean isCachedModel()

Determines 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)

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

isEscapedModel

boolean isEscapedModel()

Determines if this model instance is escaped.

Returns:

true if this model instance is escaped; false otherwise

See Also:

setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)

Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Gets the primary key of this model instance.

Returns:

the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Gets the expando bridge for this model instance.

Returns:

the expando bridge for this model instance

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 retrieve the expando bridge attributes from

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()

Creates a shallow clone of this model instance.

Returns:

the shallow clone of this model instance

toXmlString

String toXmlString()

Gets the XML representation of this model instance.

Returns:

the XML representation of this model instance