Class TemplateEntryLocalServiceUtil
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic TemplateEntryaddTemplateEntry(TemplateEntry templateEntry) Adds the template entry to the database.static TemplateEntryaddTemplateEntry(String externalReferenceCode, long userId, long groupId, long ddmTemplateId, String infoItemClassName, String infoItemFormVariationKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static TemplateEntrycreateTemplateEntry(long templateEntryId) Creates a new template entry with the primary key.static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static voiddeleteTemplateEntries(long groupId) static TemplateEntrydeleteTemplateEntry(long templateEntryId) Deletes the template entry with the primary key from the database.static TemplateEntrydeleteTemplateEntry(TemplateEntry templateEntry) Deletes the template entry from the database.static TemplateEntrydeleteTemplateEntry(String externalReferenceCode, long groupId) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.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.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.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(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.static TemplateEntryfetchTemplateEntry(long templateEntryId) static TemplateEntryfetchTemplateEntryByDDMTemplateId(long ddmTemplateId) static TemplateEntryfetchTemplateEntryByExternalReferenceCode(String externalReferenceCode, long groupId) static TemplateEntryfetchTemplateEntryByUuidAndGroupId(String uuid, long groupId) Returns the template entry matching the UUID and group.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static TemplateEntryLocalServicestatic List<TemplateEntry>getTemplateEntries(int start, int end) Returns a range of all the template entries.static List<TemplateEntry>getTemplateEntries(long[] groupIds) static List<TemplateEntry>getTemplateEntries(long[] groupIds, String infoItemClassName, String infoItemFormVariationKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TemplateEntry> orderByComparator) static List<TemplateEntry>getTemplateEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TemplateEntry> orderByComparator) static List<TemplateEntry>getTemplateEntries(long groupId, String infoItemClassName, String infoItemFormVariationKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TemplateEntry> orderByComparator) static List<TemplateEntry>getTemplateEntriesByUuidAndCompanyId(String uuid, long companyId) Returns all the template entries matching the UUID and company.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.static intReturns the number of template entries.static intgetTemplateEntriesCount(long groupId) static TemplateEntrygetTemplateEntry(long templateEntryId) Returns the template entry with the primary key.static TemplateEntrygetTemplateEntryByExternalReferenceCode(String externalReferenceCode, long groupId) static TemplateEntrygetTemplateEntryByUuidAndGroupId(String uuid, long groupId) Returns the template entry matching the UUID and group.static TemplateEntryupdateTemplateEntry(long templateEntryId) static TemplateEntryupdateTemplateEntry(TemplateEntry templateEntry) Updates the template entry in the database or adds it if it does not yet exist.static TemplateEntryupdateTemplateEntry(String externalReferenceCode, long groupId)
-
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
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
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
-
deleteTemplateEntry
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
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.template.model.impl.TemplateEntryModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.template.model.impl.TemplateEntryModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchTemplateEntry
-
fetchTemplateEntryByDDMTemplateId
-
fetchTemplateEntryByExternalReferenceCode
public static TemplateEntry fetchTemplateEntryByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchTemplateEntryByUuidAndGroupId
Returns the template entry matching the UUID and group.- Parameters:
uuid- the template entry's UUIDgroupId- the primary key of the group- Returns:
- the matching template entry, or
nullif 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
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
Returns a range of all the template entries.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.template.model.impl.TemplateEntryModelImpl.- Parameters:
start- the lower bound of the range of template entriesend- 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
-
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
Returns all the template entries matching the UUID and company.- Parameters:
uuid- the UUID of the template entriescompanyId- 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 entriescompanyId- the primary key of the companystart- the lower bound of the range of template entriesend- the upper bound of the range of template entries (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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 UUIDgroupId- 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
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
-