Interface BasePersistence<T extends BaseModel<T>>

All Known Subinterfaces:
AddressPersistence, AnnouncementsDeliveryPersistence, AnnouncementsEntryPersistence, AnnouncementsFlagPersistence, AssetCategoryPersistence, AssetEntryPersistence, AssetTagPersistence, AssetVocabularyPersistence, BrowserTrackerPersistence, ClassNamePersistence, CompanyInfoPersistence, CompanyPersistence, ContactPersistence, CountryLocalizationPersistence, CountryPersistence, CTPersistence<T>, DLFileEntryMetadataPersistence, DLFileEntryPersistence, DLFileEntryTypePersistence, DLFileShortcutPersistence, DLFileVersionPersistence, DLFolderPersistence, EmailAddressPersistence, ExpandoColumnPersistence, ExpandoRowPersistence, ExpandoTablePersistence, ExpandoValuePersistence, ExportImportConfigurationPersistence, GroupPersistence, ImagePersistence, LayoutBranchPersistence, LayoutFriendlyURLPersistence, LayoutPersistence, LayoutPrototypePersistence, LayoutRevisionPersistence, LayoutSetBranchPersistence, LayoutSetPersistence, LayoutSetPrototypePersistence, ListTypePersistence, MembershipRequestPersistence, OrganizationPersistence, OrgLaborPersistence, PasswordPolicyPersistence, PasswordPolicyRelPersistence, PasswordTrackerPersistence, PhonePersistence, PluginSettingPersistence, PortalPreferencesPersistence, PortalPreferenceValuePersistence, PortletItemPersistence, PortletPersistence, PortletPreferencesPersistence, PortletPreferenceValuePersistence, RatingsEntryPersistence, RatingsStatsPersistence, RecentLayoutBranchPersistence, RecentLayoutRevisionPersistence, RecentLayoutSetBranchPersistence, RegionLocalizationPersistence, RegionPersistence, ReleasePersistence, RememberMeTokenPersistence, RepositoryEntryPersistence, RepositoryPersistence, ResourceActionPersistence, ResourcePermissionPersistence, RolePersistence, ServiceComponentPersistence, SocialActivityAchievementPersistence, SocialActivityCounterPersistence, SocialActivityLimitPersistence, SocialActivityPersistence, SocialActivitySetPersistence, SocialActivitySettingPersistence, SocialRelationPersistence, SocialRequestPersistence, SubscriptionPersistence, SystemEventPersistence, TeamPersistence, TicketPersistence, UserGroupGroupRolePersistence, UserGroupPersistence, UserGroupRolePersistence, UserIdMapperPersistence, UserNotificationDeliveryPersistence, UserNotificationEventPersistence, UserPersistence, UserTrackerPathPersistence, UserTrackerPersistence, VirtualHostPersistence, WebDAVPropsPersistence, WebsitePersistence, WorkflowDefinitionLinkPersistence, WorkflowInstanceLinkPersistence
All Known Implementing Classes:
BasePersistenceImpl

public interface BasePersistence<T extends BaseModel<T>>
The base interface for all ServiceBuilder persistence classes. This interface should never need to be used directly.

Caching information and settings can be found in portal.properties

Author:
Brian Wing Shun Chan
See Also:
  • Method Details

    • clearCache

      void clearCache()
      Clears the cache for all instances of this model.

      The EntityCache and FinderCache are both cleared by this method.

    • clearCache

      void clearCache(List<T> modelList)
      Clears the cache for a List instances of this model.

      The EntityCache and FinderCache are both cleared by this method.

      Parameters:
      modelList - the List instances of this model to clear the cache for
    • clearCache

      default void clearCache(Set<Serializable> primaryKeys)
    • clearCache

      void clearCache(T model)
      Clears the cache for one instance of this model.

      The EntityCache and FinderCache are both cleared by this method.

      Parameters:
      model - the instance of this model to clear the cache for
    • closeSession

      void closeSession(Session session)
    • countWithDynamicQuery

      long countWithDynamicQuery(DynamicQuery dynamicQuery)
      Returns the number of rows that match the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows that match the dynamic query
    • countWithDynamicQuery

      long countWithDynamicQuery(DynamicQuery dynamicQuery, Projection projection)
      Returns the number of rows that match the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows that match the dynamic query
    • dslQuery

      <R> R dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      default int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • fetchByPrimaryKey

      T fetchByPrimaryKey(Serializable primaryKey)
      Returns the model instance with the primary key or returns null if it could not be found.
      Parameters:
      primaryKey - the primary key of the model instance
      Returns:
      the model instance, or null if an instance of this model with the primary key could not be found
    • fetchByPrimaryKeys

      Map<Serializable,T> fetchByPrimaryKeys(Set<Serializable> primaryKeys)
    • findByPrimaryKey

      T findByPrimaryKey(Serializable primaryKey) throws NoSuchModelException
      Returns the model instance with the primary key or throws a NoSuchModelException if it could not be found.
      Parameters:
      primaryKey - the primary key of the model instance
      Returns:
      the model instance
      Throws:
      NoSuchModelException
    • findWithDynamicQuery

      <V> List<V> findWithDynamicQuery(DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • findWithDynamicQuery

      <V> List<V> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
      Performs a dynamic query on the database and returns a range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of matching rows
      end - the upper bound of the range of matching rows (not inclusive)
      Returns:
      the range of matching rows
      See Also:
    • findWithDynamicQuery

      <V> List<V> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<V> orderByComparator)
      Performs a dynamic query on the database and returns an ordered range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of matching rows
      end - the upper bound of the range of matching rows (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching rows
    • flush

      void flush()
    • getBadColumnNames

      Set<String> getBadColumnNames()
    • getCurrentSession

      Session getCurrentSession() throws ORMException
      Throws:
      ORMException
    • getDataSource

      DataSource getDataSource()
      Returns the data source for this model.
      Returns:
      the data source for this model
      See Also:
    • getDB

      DB getDB()
    • getDialect

      Dialect getDialect()
    • getListeners

      ModelListener<T>[] getListeners()
      Returns the listeners registered for this model.
      Returns:
      the listeners registered for this model
      See Also:
    • getModelClass

      Class<T> getModelClass()
    • openSession

      Session openSession() throws ORMException
      Throws:
      ORMException
    • processException

      SystemException processException(Exception exception)
    • registerListener

      void registerListener(ModelListener<T> modelListener)
      Registers a new listener for this model.

      A model listener is notified whenever a change is made to an instance of this model, such as when one is added, updated, or removed.

      Parameters:
      listener - the model listener to register
    • remove

      T remove(Serializable primaryKey) throws NoSuchModelException
      Removes the model instance with the primary key from the database. Also notifies the appropriate model listeners.
      Parameters:
      primaryKey - the primary key of the model instance to remove
      Returns:
      the model instance that was removed
      Throws:
      NoSuchModelException
    • remove

      T remove(T model)
      Removes the model instance from the database. Also notifies the appropriate model listeners.
      Parameters:
      model - the model instance to remove
      Returns:
      the model instance that was removed
    • removeByFunction

      T removeByFunction(T model, Function<T,T> function)
    • setDataSource

      void setDataSource(DataSource dataSource)
      Sets the data source for this model.
      Parameters:
      dataSource - the data source to use for this model
    • unregisterListener

      void unregisterListener(ModelListener<T> modelListener)
      Unregisters the model listener.
      Parameters:
      listener - the model listener to unregister
      See Also:
    • update

      T update(T model)
      Updates the model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Typically not called directly, use local service update model methods instead. For example, UserLocalServiceUtil.updateUser(com.liferay.portal.kernel.model.User).

      Parameters:
      model - the model instance to update
      Returns:
      the model instance that was updated
    • update

      T update(T model, ServiceContext serviceContext)
      Updates the model instance in the database or adds it if it does not yet exist, within a different service context. Also notifies the appropriate model listeners.
      Parameters:
      model - the model instance to update
      serviceContext - the service context to be applied
      Returns:
      the model instance that was updated