Class TemplateEntryLocalServiceUtil

java.lang.Object
com.liferay.template.service.TemplateEntryLocalServiceUtil

public class TemplateEntryLocalServiceUtil extends Object
Provides the local service utility for TemplateEntry. This utility wraps com.liferay.template.service.impl.TemplateEntryLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:
  • Constructor Details

    • TemplateEntryLocalServiceUtil

      public TemplateEntryLocalServiceUtil()
  • Method Details

    • addTemplateEntry

      public static 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

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createTemplateEntry

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteTemplateEntries

      public static void deleteTemplateEntries(long groupId)
    • deleteTemplateEntry

      public static 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

      public static TemplateEntry deleteTemplateEntry(String externalReferenceCode, long groupId)
    • deleteTemplateEntry

      public static 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

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <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

      public static <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

      public static <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

      public static 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

      public static 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

      public static TemplateEntry fetchTemplateEntry(long templateEntryId)
    • fetchTemplateEntryByDDMTemplateId

      public static TemplateEntry fetchTemplateEntryByDDMTemplateId(long ddmTemplateId)
    • fetchTemplateEntryByExternalReferenceCode

      public static TemplateEntry fetchTemplateEntryByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchTemplateEntryByUuidAndGroupId

      public static 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

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getTemplateEntries

      public static 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

      public static List<TemplateEntry> getTemplateEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TemplateEntry> orderByComparator)
    • getTemplateEntries

      public static List<TemplateEntry> getTemplateEntries(long groupId, String infoItemClassName, String infoItemFormVariationKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TemplateEntry> orderByComparator)
    • getTemplateEntries

      public static List<TemplateEntry> getTemplateEntries(long[] groupIds)
    • getTemplateEntries

      public static List<TemplateEntry> getTemplateEntries(long[] groupIds, String infoItemClassName, String infoItemFormVariationKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TemplateEntry> orderByComparator)
    • getTemplateEntriesByUuidAndCompanyId

      public static 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

      public static 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

      public static int getTemplateEntriesCount()
      Returns the number of template entries.
      Returns:
      the number of template entries
    • getTemplateEntriesCount

      public static int getTemplateEntriesCount(long groupId)
    • getTemplateEntry

      public static 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

      public static TemplateEntry getTemplateEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getTemplateEntryByUuidAndGroupId

      public static 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

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

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

      public static 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
    • getService

      public static TemplateEntryLocalService getService()