Class DDMFormInstanceLocalServiceUtil

java.lang.Object
com.liferay.dynamic.data.mapping.service.DDMFormInstanceLocalServiceUtil

public class DDMFormInstanceLocalServiceUtil extends Object
Provides the local service utility for DDMFormInstance. This utility wraps com.liferay.dynamic.data.mapping.service.impl.DDMFormInstanceLocalServiceImpl 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

    • DDMFormInstanceLocalServiceUtil

      public DDMFormInstanceLocalServiceUtil()
  • Method Details

    • addDDMFormInstance

      public static DDMFormInstance addDDMFormInstance(DDMFormInstance ddmFormInstance)
      Adds the ddm form instance to the database. Also notifies the appropriate model listeners.

      Important: Inspect DDMFormInstanceLocalServiceImpl 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:
      ddmFormInstance - the ddm form instance
      Returns:
      the ddm form instance that was added
    • addFormInstance

      public static DDMFormInstance addFormInstance(long userId, long groupId, long ddmStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addFormInstance

      public static DDMFormInstance addFormInstance(long userId, long groupId, long ddmStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String serializedSettingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addFormInstance

      public static DDMFormInstance addFormInstance(long userId, long groupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addFormInstanceResources

      public static void addFormInstanceResources(DDMFormInstance ddmFormInstance, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addFormInstanceResources

      public static void addFormInstanceResources(DDMFormInstance ddmFormInstance, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyFormInstance

      public static DDMFormInstance copyFormInstance(long userId, long groupId, Map<Locale,String> nameMap, DDMFormInstance sourceDDMFormInstance, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createDDMFormInstance

      public static DDMFormInstance createDDMFormInstance(long formInstanceId)
      Creates a new ddm form instance with the primary key. Does not add the ddm form instance to the database.
      Parameters:
      formInstanceId - the primary key for the new ddm form instance
      Returns:
      the new ddm form instance
    • 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
    • deleteDDMFormInstance

      public static DDMFormInstance deleteDDMFormInstance(DDMFormInstance ddmFormInstance)
      Deletes the ddm form instance from the database. Also notifies the appropriate model listeners.

      Important: Inspect DDMFormInstanceLocalServiceImpl 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:
      ddmFormInstance - the ddm form instance
      Returns:
      the ddm form instance that was removed
    • deleteDDMFormInstance

      public static DDMFormInstance deleteDDMFormInstance(long formInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the ddm form instance with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect DDMFormInstanceLocalServiceImpl 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:
      formInstanceId - the primary key of the ddm form instance
      Returns:
      the ddm form instance that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a ddm form instance with the primary key could not be found
    • deleteFormInstance

      public static void deleteFormInstance(DDMFormInstance ddmFormInstance) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFormInstance

      public static void deleteFormInstance(long ddmFormInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFormInstances

      public static void deleteFormInstances(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • 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.dynamic.data.mapping.model.impl.DDMFormInstanceModelImpl.

      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.dynamic.data.mapping.model.impl.DDMFormInstanceModelImpl.

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

      public static DDMFormInstance fetchDDMFormInstance(long formInstanceId)
    • fetchDDMFormInstanceByUuidAndGroupId

      public static DDMFormInstance fetchDDMFormInstanceByUuidAndGroupId(String uuid, long groupId)
      Returns the ddm form instance matching the UUID and group.
      Parameters:
      uuid - the ddm form instance's UUID
      groupId - the primary key of the group
      Returns:
      the matching ddm form instance, or null if a matching ddm form instance could not be found
    • fetchFormInstance

      public static DDMFormInstance fetchFormInstance(long ddmFormInstanceId)
    • getActionableDynamicQuery

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

      public static DDMFormInstance getDDMFormInstance(long formInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the ddm form instance with the primary key.
      Parameters:
      formInstanceId - the primary key of the ddm form instance
      Returns:
      the ddm form instance
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a ddm form instance with the primary key could not be found
    • getDDMFormInstanceByUuidAndGroupId

      public static DDMFormInstance getDDMFormInstanceByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the ddm form instance matching the UUID and group.
      Parameters:
      uuid - the ddm form instance's UUID
      groupId - the primary key of the group
      Returns:
      the matching ddm form instance
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching ddm form instance could not be found
    • getDDMFormInstances

      public static List<DDMFormInstance> getDDMFormInstances(int start, int end)
      Returns a range of all the ddm form instances.

      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.dynamic.data.mapping.model.impl.DDMFormInstanceModelImpl.

      Parameters:
      start - the lower bound of the range of ddm form instances
      end - the upper bound of the range of ddm form instances (not inclusive)
      Returns:
      the range of ddm form instances
    • getDDMFormInstancesByUuidAndCompanyId

      public static List<DDMFormInstance> getDDMFormInstancesByUuidAndCompanyId(String uuid, long companyId)
      Returns all the ddm form instances matching the UUID and company.
      Parameters:
      uuid - the UUID of the ddm form instances
      companyId - the primary key of the company
      Returns:
      the matching ddm form instances, or an empty list if no matches were found
    • getDDMFormInstancesByUuidAndCompanyId

      public static List<DDMFormInstance> getDDMFormInstancesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMFormInstance> orderByComparator)
      Returns a range of ddm form instances matching the UUID and company.
      Parameters:
      uuid - the UUID of the ddm form instances
      companyId - the primary key of the company
      start - the lower bound of the range of ddm form instances
      end - the upper bound of the range of ddm form instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching ddm form instances, or an empty list if no matches were found
    • getDDMFormInstancesCount

      public static int getDDMFormInstancesCount()
      Returns the number of ddm form instances.
      Returns:
      the number of ddm form instances
    • getExportActionableDynamicQuery

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

      public static DDMFormInstance getFormInstance(long ddmFormInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFormInstance

      public static DDMFormInstance getFormInstance(String uuid, long ddmFormInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFormInstanceByStructureId

      public static DDMFormInstance getFormInstanceByStructureId(long structureId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFormInstances

      public static List<DDMFormInstance> getFormInstances(long groupId)
    • getFormInstancesCount

      public static int getFormInstancesCount(long groupId)
    • getFormInstancesCount

      public static int getFormInstancesCount(String uuid) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFormInstanceSettingsFormValues

      public static DDMFormValues getFormInstanceSettingsFormValues(DDMFormInstance formInstance) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFormInstanceSettingsModel

      public static DDMFormInstanceSettings getFormInstanceSettingsModel(DDMFormInstance formInstance) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • search

      public static List<DDMFormInstance> search(long companyId, long groupId, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMFormInstance> orderByComparator)
    • search

      public static List<DDMFormInstance> search(long companyId, long groupId, String[] names, String[] descriptions, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMFormInstance> orderByComparator)
    • searchCount

      public static int searchCount(long companyId, long groupId, String keywords)
    • searchCount

      public static int searchCount(long companyId, long groupId, String[] names, String[] descriptions, boolean andOperator)
    • sendEmail

      public static void sendEmail(long userId, String message, String subject, String[] toEmailAddresses) throws Exception
      Throws:
      Exception
    • updateDDMFormInstance

      public static DDMFormInstance updateDDMFormInstance(DDMFormInstance ddmFormInstance)
      Updates the ddm form instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect DDMFormInstanceLocalServiceImpl 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:
      ddmFormInstance - the ddm form instance
      Returns:
      the ddm form instance that was updated
    • updateFormInstance

      public static DDMFormInstance updateFormInstance(long formInstanceId, DDMFormValues settingsDDMFormValues) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFormInstance

      public static DDMFormInstance updateFormInstance(long userId, long ddmFormInstanceId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFormInstance

      public static DDMFormInstance updateFormInstance(long ddmFormInstanceId, long ddmStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static DDMFormInstanceLocalService getService()