Interface TemplateEntryLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<TemplateEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
TemplateEntryLocalServiceWrapper

@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface TemplateEntryLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<TemplateEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for TemplateEntry. 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

    • addTemplateEntry

      TemplateEntry addTemplateEntry(String externalReferenceCode, long userId, long groupId, long ddmTemplateId, String infoItemClassName, String infoItemFormVariationKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addTemplateEntry

      @Indexable(type=REINDEX) TemplateEntry addTemplateEntry(TemplateEntry templateEntry)
      Adds the template entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect TemplateEntryLocalServiceImpl 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:
      templateEntry - the template entry
      Returns:
      the template entry that was added
    • 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
    • createTemplateEntry

      @Transactional(enabled=false) TemplateEntry createTemplateEntry(long templateEntryId)
      Creates a new template entry with the primary key. Does not add the template entry to the database.
      Parameters:
      templateEntryId - the primary key for the new template entry
      Returns:
      the new template entry
    • 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
    • deleteTemplateEntries

      void deleteTemplateEntries(long groupId)
    • deleteTemplateEntry

      @Indexable(type=DELETE) TemplateEntry deleteTemplateEntry(long templateEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the template entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect TemplateEntryLocalServiceImpl 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:
      templateEntryId - the primary key of the template entry
      Returns:
      the template entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a template entry with the primary key could not be found
    • deleteTemplateEntry

      TemplateEntry deleteTemplateEntry(String externalReferenceCode, long groupId)
    • deleteTemplateEntry

      @Indexable(type=DELETE) TemplateEntry deleteTemplateEntry(TemplateEntry templateEntry)
      Deletes the template entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect TemplateEntryLocalServiceImpl 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:
      templateEntry - the template entry
      Returns:
      the template entry that was removed
    • 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.template.model.impl.TemplateEntryModelImpl.

      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.template.model.impl.TemplateEntryModelImpl.

      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
    • fetchTemplateEntry

      @Transactional(propagation=SUPPORTS, readOnly=true) TemplateEntry fetchTemplateEntry(long templateEntryId)
    • fetchTemplateEntryByDDMTemplateId

      @Transactional(propagation=SUPPORTS, readOnly=true) TemplateEntry fetchTemplateEntryByDDMTemplateId(long ddmTemplateId)
    • fetchTemplateEntryByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) TemplateEntry fetchTemplateEntryByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchTemplateEntryByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) TemplateEntry fetchTemplateEntryByUuidAndGroupId(String uuid, long groupId)
      Returns the template entry matching the UUID and group.
      Parameters:
      uuid - the template entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching template entry, or null if a matching template entry could not be found
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • 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
    • getTemplateEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<TemplateEntry> getTemplateEntries(int start, int end)
      Returns a range of all the template 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.template.model.impl.TemplateEntryModelImpl.

      Parameters:
      start - the lower bound of the range of template entries
      end - the upper bound of the range of template entries (not inclusive)
      Returns:
      the range of template entries
    • getTemplateEntries

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<TemplateEntry> getTemplateEntries(long groupId, String infoItemClassName, String infoItemFormVariationKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TemplateEntry> orderByComparator)
    • getTemplateEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<TemplateEntry> getTemplateEntries(long[] groupIds)
    • getTemplateEntries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<TemplateEntry> getTemplateEntries(long[] groupIds, String infoItemClassName, String infoItemFormVariationKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TemplateEntry> orderByComparator)
    • getTemplateEntriesByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<TemplateEntry> getTemplateEntriesByUuidAndCompanyId(String uuid, long companyId)
      Returns all the template entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the template entries
      companyId - the primary key of the company
      Returns:
      the matching template entries, or an empty list if no matches were found
    • getTemplateEntriesByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<TemplateEntry> getTemplateEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TemplateEntry> orderByComparator)
      Returns a range of template entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the template entries
      companyId - the primary key of the company
      start - the lower bound of the range of template entries
      end - the upper bound of the range of template entries (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching template entries, or an empty list if no matches were found
    • getTemplateEntriesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getTemplateEntriesCount()
      Returns the number of template entries.
      Returns:
      the number of template entries
    • getTemplateEntriesCount

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

      @Transactional(propagation=SUPPORTS, readOnly=true) TemplateEntry getTemplateEntry(long templateEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the template entry with the primary key.
      Parameters:
      templateEntryId - the primary key of the template entry
      Returns:
      the template entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a template entry with the primary key could not be found
    • getTemplateEntryByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) TemplateEntry getTemplateEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getTemplateEntryByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) TemplateEntry getTemplateEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the template entry matching the UUID and group.
      Parameters:
      uuid - the template entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching template entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching template entry could not be found
    • updateTemplateEntry

      TemplateEntry updateTemplateEntry(long templateEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateTemplateEntry

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

      @Indexable(type=REINDEX) TemplateEntry updateTemplateEntry(TemplateEntry templateEntry)
      Updates the template entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect TemplateEntryLocalServiceImpl 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:
      templateEntry - the template entry
      Returns:
      the template entry that was updated
    • getCTPersistence

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

      @Transactional(enabled=false) Class<TemplateEntry> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<TemplateEntry>
    • 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<TemplateEntry>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<TemplateEntry>
      Throws:
      E extends Throwable