Interface StyleBookEntryLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<StyleBookEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService, com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
All Known Implementing Classes:
StyleBookEntryLocalServiceWrapper

@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface StyleBookEntryLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<StyleBookEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService, com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
Provides the local service interface for StyleBookEntry. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
See Also:
Generated:
  • Method Details

    • addStyleBookEntry

      StyleBookEntry addStyleBookEntry(String externalReferenceCode, long userId, long groupId, boolean defaultStyleBookEntry, String frontendTokensValues, String name, String styleBookEntryKey, String themeId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addStyleBookEntry

      @Indexable(type=REINDEX) StyleBookEntry addStyleBookEntry(StyleBookEntry styleBookEntry)
      Adds the style book entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect StyleBookEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      styleBookEntry - the style book entry
      Returns:
      the style book entry that was added
    • checkout

      @Indexable(type=REINDEX) StyleBookEntry checkout(StyleBookEntry publishedStyleBookEntry, int version) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      checkout in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyStyleBookEntry

      StyleBookEntry copyStyleBookEntry(long userId, long groupId, long sourceStyleBookEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • create

      @Transactional(enabled=false) StyleBookEntry create()
      Creates a new style book entry. Does not add the style book entry to the database.
      Specified by:
      create in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
      Returns:
      the new style book entry
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • delete

      @Indexable(type=DELETE) StyleBookEntry delete(StyleBookEntry publishedStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      delete in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteDraft

      @Indexable(type=DELETE) StyleBookEntry deleteDraft(StyleBookEntry draftStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deleteDraft in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteStyleBookEntries

      void deleteStyleBookEntries(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteStyleBookEntry

      @Indexable(type=DELETE) StyleBookEntry deleteStyleBookEntry(long styleBookEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the style book entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect StyleBookEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      styleBookEntryId - the primary key of the style book entry
      Returns:
      the style book entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a style book entry with the primary key could not be found
    • deleteStyleBookEntry

      StyleBookEntry deleteStyleBookEntry(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteStyleBookEntry

      @Indexable(type=DELETE) StyleBookEntry deleteStyleBookEntry(StyleBookEntry styleBookEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the style book entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect StyleBookEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      styleBookEntry - the style book entry
      Returns:
      the style book entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteVersion

      StyleBookEntryVersion deleteVersion(StyleBookEntryVersion styleBookEntryVersion) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deleteVersion in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.style.book.model.impl.StyleBookEntryModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.style.book.model.impl.StyleBookEntryModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchDefaultStyleBookEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry fetchDefaultStyleBookEntry(long groupId, String themeId)
    • fetchDraft

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry fetchDraft(long primaryKey)
      Specified by:
      fetchDraft in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
    • fetchDraft

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry fetchDraft(StyleBookEntry styleBookEntry)
      Specified by:
      fetchDraft in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
    • fetchLatestVersion

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntryVersion fetchLatestVersion(StyleBookEntry styleBookEntry)
      Specified by:
      fetchLatestVersion in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
    • fetchPublished

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry fetchPublished(long primaryKey)
      Specified by:
      fetchPublished in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
    • fetchPublished

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry fetchPublished(StyleBookEntry styleBookEntry)
      Specified by:
      fetchPublished in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
    • fetchStyleBookEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry fetchStyleBookEntry(long styleBookEntryId)
    • fetchStyleBookEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry fetchStyleBookEntry(long groupId, String styleBookEntryKey)
    • fetchStyleBookEntryByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry fetchStyleBookEntryByUuidAndGroupId(String uuid, long groupId)
    • generateStyleBookEntryKey

      String generateStyleBookEntryKey(long groupId, String name)
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getDraft

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry getDraft(long primaryKey) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getDraft in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getDraft

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry getDraft(StyleBookEntry styleBookEntry) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getDraft in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getStyleBookEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<StyleBookEntry> getStyleBookEntries(int start, int end)
      Returns a range of all the style book entries.

      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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.style.book.model.impl.StyleBookEntryModelImpl.

      Parameters:
      start - the lower bound of the range of style book entries
      end - the upper bound of the range of style book entries (not inclusive)
      Returns:
      the range of style book entries
    • getStyleBookEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<StyleBookEntry> getStyleBookEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<StyleBookEntry> orderByComparator)
    • getStyleBookEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<StyleBookEntry> getStyleBookEntries(long groupId, String themeId)
    • getStyleBookEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<StyleBookEntry> getStyleBookEntries(long groupId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<StyleBookEntry> orderByComparator)
    • getStyleBookEntriesByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<StyleBookEntry> getStyleBookEntriesByUuidAndCompanyId(String uuid, long companyId)
    • getStyleBookEntriesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getStyleBookEntriesCount()
      Returns the number of style book entries.
      Returns:
      the number of style book entries
    • getStyleBookEntriesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getStyleBookEntriesCount(long groupId)
    • getStyleBookEntriesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getStyleBookEntriesCount(long groupId, String name)
    • getStyleBookEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntry getStyleBookEntry(long styleBookEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the style book entry with the primary key.
      Parameters:
      styleBookEntryId - the primary key of the style book entry
      Returns:
      the style book entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a style book entry with the primary key could not be found
    • getVersion

      @Transactional(propagation=SUPPORTS, readOnly=true) StyleBookEntryVersion getVersion(StyleBookEntry styleBookEntry, int version) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getVersion in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getVersions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<StyleBookEntryVersion> getVersions(StyleBookEntry styleBookEntry)
      Specified by:
      getVersions in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
    • publishDraft

      @Indexable(type=REINDEX) StyleBookEntry publishDraft(StyleBookEntry draftStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      publishDraft in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • registerListener

      void registerListener(com.liferay.portal.kernel.service.version.VersionServiceListener<StyleBookEntry,StyleBookEntryVersion> versionServiceListener)
      Specified by:
      registerListener in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
    • unregisterListener

      void unregisterListener(com.liferay.portal.kernel.service.version.VersionServiceListener<StyleBookEntry,StyleBookEntryVersion> versionServiceListener)
      Specified by:
      unregisterListener in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
    • updateDefaultStyleBookEntry

      StyleBookEntry updateDefaultStyleBookEntry(long styleBookEntryId, boolean defaultStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateDraft

      @Indexable(type=REINDEX) StyleBookEntry updateDraft(StyleBookEntry draftStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      updateDraft in interface com.liferay.portal.kernel.service.version.VersionService<StyleBookEntry,StyleBookEntryVersion>
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFrontendTokensValues

      StyleBookEntry updateFrontendTokensValues(long styleBookEntryId, String frontendTokensValues) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateName

      StyleBookEntry updateName(long styleBookEntryId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updatePreviewFileEntryId

      StyleBookEntry updatePreviewFileEntryId(long styleBookEntryId, long previewFileEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStyleBookEntry

      StyleBookEntry updateStyleBookEntry(long userId, long styleBookEntryId, boolean defaultStylebookEntry, String frontendTokensValues, String name, String styleBookEntryKey, long previewFileEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStyleBookEntry

      StyleBookEntry updateStyleBookEntry(long styleBookEntryId, String frontendTokensValues, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStyleBookEntry

      @Indexable(type=REINDEX) StyleBookEntry updateStyleBookEntry(StyleBookEntry draftStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException
      Updates the style book entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect StyleBookEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      draftStyleBookEntry - the style book entry
      Returns:
      the style book entry that was updated
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCTPersistence

      @Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<StyleBookEntry> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<StyleBookEntry>
    • getModelClass

      @Transactional(enabled=false) Class<StyleBookEntry> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<StyleBookEntry>
    • updateWithUnsafeFunction

      @Transactional(rollbackFor=java.lang.Throwable.class) <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<StyleBookEntry>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<StyleBookEntry>
      Throws:
      E extends Throwable