Liferay 6.2-ce-ga5

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

All Superinterfaces:
ClassedModel, 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, BackgroundTask, BackgroundTaskModel, BlogsEntry, BlogsEntryModel, BlogsStatsUser, BlogsStatsUserModel, BookmarksEntry, BookmarksEntryModel, BookmarksFolder, BookmarksFolderModel, BrowserTracker, BrowserTrackerModel, CalEvent, CalEventModel, ClassName, ClassNameModel, ClusterGroup, ClusterGroupModel, Company, CompanyModel, Contact, ContactModel, Counter, CounterModel, Country, CountryModel, DDLRecord, DDLRecordModel, DDLRecordSet, DDLRecordSetModel, DDLRecordVersion, DDLRecordVersionModel, DDMContent, DDMContentModel, DDMStorageLink, DDMStorageLinkModel, DDMStructure, DDMStructureLink, DDMStructureLinkModel, DDMStructureModel, DDMTemplate, DDMTemplateModel, DLContent, DLContentModel, DLFileEntry, DLFileEntryMetadata, DLFileEntryMetadataModel, DLFileEntryModel, DLFileEntryType, DLFileEntryTypeModel, DLFileRank, DLFileRankModel, DLFileShortcut, DLFileShortcutModel, DLFileVersion, DLFileVersionModel, DLFolder, DLFolderModel, DLSyncEvent, DLSyncEventModel, Dummy, DummyModel, EmailAddress, EmailAddressModel, ExpandoColumn, ExpandoColumnModel, ExpandoRow, ExpandoRowModel, ExpandoTable, ExpandoTableModel, ExpandoValue, ExpandoValueModel, Group, GroupModel, Image, ImageModel, JournalArticle, JournalArticleImage, JournalArticleImageModel, JournalArticleModel, JournalArticleResource, JournalArticleResourceModel, JournalContentSearch, JournalContentSearchModel, JournalFeed, JournalFeedModel, JournalFolder, JournalFolderModel, Layout, LayoutBranch, LayoutBranchModel, LayoutFriendlyURL, LayoutFriendlyURLModel, LayoutModel, LayoutPrototype, LayoutPrototypeModel, LayoutRevision, LayoutRevisionModel, LayoutSet, LayoutSetBranch, LayoutSetBranchModel, LayoutSetModel, LayoutSetPrototype, LayoutSetPrototypeModel, ListType, ListTypeModel, Lock, LockModel, MBBan, MBBanModel, MBCategory, MBCategoryModel, MBDiscussion, MBDiscussionModel, MBMailingList, MBMailingListModel, MBMessage, MBMessageModel, MBStatsUser, MBStatsUserModel, MBThread, MBThreadFlag, MBThreadFlagModel, MBThreadModel, MDRAction, MDRActionModel, MDRRule, MDRRuleGroup, MDRRuleGroupInstance, MDRRuleGroupInstanceModel, MDRRuleGroupModel, MDRRuleModel, MembershipRequest, MembershipRequestModel, Organization, OrganizationModel, OrgGroupRole, OrgGroupRoleModel, OrgLabor, OrgLaborModel, PasswordPolicy, PasswordPolicyModel, PasswordPolicyRel, PasswordPolicyRelModel, PasswordTracker, PasswordTrackerModel, Phone, PhoneModel, PluginSetting, PluginSettingModel, PollsChoice, PollsChoiceModel, PollsQuestion, PollsQuestionModel, PollsVote, PollsVoteModel, PortalPreferences, PortalPreferencesModel, Portlet, PortletItem, PortletItemModel, PortletModel, PortletPreferences, PortletPreferencesModel, RatingsEntry, RatingsEntryModel, RatingsStats, RatingsStatsModel, Region, RegionModel, Release, ReleaseModel, Repository, RepositoryEntry, RepositoryEntryModel, RepositoryModel, ResourceAction, ResourceActionModel, ResourceBlock, ResourceBlockModel, ResourceBlockPermission, ResourceBlockPermissionModel, ResourcePermission, ResourcePermissionModel, ResourceTypePermission, ResourceTypePermissionModel, 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, SocialActivityAchievement, SocialActivityAchievementModel, SocialActivityCounter, SocialActivityCounterModel, SocialActivityLimit, SocialActivityLimitModel, SocialActivityModel, SocialActivitySet, SocialActivitySetModel, SocialActivitySetting, SocialActivitySettingModel, SocialRelation, SocialRelationModel, SocialRequest, SocialRequestModel, 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, WikiNode, WikiNodeModel, WikiPage, WikiPageModel, WikiPageResource, WikiPageResourceModel, WorkflowDefinitionLink, WorkflowDefinitionLinkModel, WorkflowInstanceLink, WorkflowInstanceLinkModel
All Known Implementing Classes:
AccountWrapper, AddressWrapper, AnnouncementsDeliveryWrapper, AnnouncementsEntryWrapper, AnnouncementsFlagWrapper, AssetCategoryPropertyWrapper, AssetCategoryWrapper, AssetEntryWrapper, AssetLinkWrapper, AssetTagPropertyWrapper, AssetTagStatsWrapper, AssetTagWrapper, AssetVocabularyWrapper, BackgroundTaskWrapper, BaseModelImpl, BlogsEntryWrapper, BlogsStatsUserWrapper, BookmarksEntryWrapper, BookmarksFolderWrapper, BrowserTrackerWrapper, CalEventWrapper, ClassNameWrapper, ClusterGroupWrapper, CompanyWrapper, ContactWrapper, CounterWrapper, CountryWrapper, DDLRecordSetWrapper, DDLRecordVersionWrapper, DDLRecordWrapper, DDMContentWrapper, DDMStorageLinkWrapper, DDMStructureLinkWrapper, DDMStructureWrapper, DDMTemplateWrapper, DLContentWrapper, DLFileEntryMetadataWrapper, DLFileEntryTypeWrapper, DLFileEntryWrapper, DLFileRankWrapper, DLFileShortcutWrapper, DLFileVersionWrapper, DLFolderWrapper, DLSyncEventWrapper, EmailAddressWrapper, ExpandoColumnWrapper, ExpandoRowWrapper, ExpandoTableWrapper, ExpandoValueWrapper, GroupWrapper, ImageWrapper, JournalArticleImageWrapper, JournalArticleResourceWrapper, JournalArticleWrapper, JournalContentSearchWrapper, JournalFeedWrapper, JournalFolderWrapper, LayoutBranchWrapper, LayoutFriendlyURLWrapper, LayoutPrototypeWrapper, LayoutRevisionWrapper, LayoutSetBranchWrapper, LayoutSetPrototypeWrapper, LayoutSetWrapper, LayoutWrapper, ListTypeWrapper, LockWrapper, MBBanWrapper, MBCategoryWrapper, MBDiscussionWrapper, MBMailingListWrapper, MBMessageWrapper, MBStatsUserWrapper, MBThreadFlagWrapper, MBThreadWrapper, MDRActionWrapper, MDRRuleGroupInstanceWrapper, MDRRuleGroupWrapper, MDRRuleWrapper, MembershipRequestWrapper, OrganizationWrapper, OrgGroupRoleWrapper, OrgLaborWrapper, PasswordPolicyRelWrapper, PasswordPolicyWrapper, PasswordTrackerWrapper, PhoneWrapper, PluginSettingWrapper, PollsChoiceWrapper, PollsQuestionWrapper, PollsVoteWrapper, PortalPreferencesWrapper, PortletItemWrapper, PortletPreferencesWrapper, PortletWrapper, RatingsEntryWrapper, RatingsStatsWrapper, RegionWrapper, ReleaseWrapper, RepositoryEntryWrapper, RepositoryWrapper, ResourceActionWrapper, ResourceBlockPermissionWrapper, ResourceBlockWrapper, ResourcePermissionWrapper, ResourceTypePermissionWrapper, RoleWrapper, SCFrameworkVersionWrapper, SCLicenseWrapper, SCProductEntryWrapper, SCProductScreenshotWrapper, SCProductVersionWrapper, ServiceComponentWrapper, ShardWrapper, ShoppingCartWrapper, ShoppingCategoryWrapper, ShoppingCouponWrapper, ShoppingItemFieldWrapper, ShoppingItemPriceWrapper, ShoppingItemWrapper, ShoppingOrderItemWrapper, ShoppingOrderWrapper, SocialActivityAchievementWrapper, SocialActivityCounterWrapper, SocialActivityLimitWrapper, SocialActivitySettingWrapper, SocialActivitySetWrapper, SocialActivityWrapper, SocialRelationWrapper, SocialRequestWrapper, SubscriptionWrapper, SystemEventWrapper, TeamWrapper, TicketWrapper, TrashEntryWrapper, TrashVersionWrapper, UserGroupGroupRoleWrapper, UserGroupRoleWrapper, UserGroupWrapper, UserIdMapperWrapper, UserNotificationDeliveryWrapper, UserNotificationEventWrapper, UserTrackerPathWrapper, UserTrackerWrapper, UserWrapper, VirtualHostWrapper, WebDAVPropsWrapper, WebsiteWrapper, WikiNodeWrapper, WikiPageResourceWrapper, WikiPageWrapper, WorkflowDefinitionLinkWrapper, WorkflowInstanceLinkWrapper

public interface BaseModel<T>
extends ClassedModel, 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()
          Returns the expando bridge for this model instance.
 Map<String,Object> getModelAttributes()
           
 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 isEscapedModel()
          Returns true if this model instance is escaped.
 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(Map<String,Object> attributes)
           
 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.
 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()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

clone

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

Map<String,Object> getModelAttributes()

getPrimaryKeyObj

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)

isEscapedModel

boolean isEscapedModel()
Returns true if this model instance is escaped.

Returns:
true if this model instance is escaped; 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(Map<String,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(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

String toXmlString()
Returns the XML representation of this model instance.

Returns:
the XML representation of this model instance

Liferay 6.2-ce-ga5