Interface DDMFormInstanceLocalService

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

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

    • addDDMFormInstance

      @Indexable(type=REINDEX) 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

      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

      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

      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

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

      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

      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

      @Transactional(enabled=false) 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

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

      @Indexable(type=DELETE) 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

      @Indexable(type=DELETE) 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

      @SystemEvent(action=1, type=1) void deleteFormInstance(DDMFormInstance ddmFormInstance) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFormInstance

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

      void deleteFormInstances(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      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
    • 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.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

      @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.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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMFormInstance fetchDDMFormInstance(long formInstanceId)
    • fetchDDMFormInstanceByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMFormInstance fetchFormInstance(long ddmFormInstanceId)
    • getActionableDynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getDDMFormInstancesCount()
      Returns the number of ddm form instances.
      Returns:
      the number of ddm form instances
    • getExportActionableDynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMFormInstance getFormInstance(long ddmFormInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFormInstance

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMFormInstance getFormInstance(String uuid, long ddmFormInstanceId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFormInstanceByStructureId

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMFormInstance getFormInstanceByStructureId(long structureId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFormInstances

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMFormInstance> getFormInstances(long groupId)
    • getFormInstancesCount

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getFormInstancesCount(String uuid) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFormInstanceSettingsFormValues

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMFormValues getFormInstanceSettingsFormValues(DDMFormInstance formInstance) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFormInstanceSettingsModel

      @Transactional(propagation=SUPPORTS, readOnly=true) DDMFormInstanceSettings getFormInstanceSettingsModel(DDMFormInstance formInstance) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) List<DDMFormInstance> search(long companyId, long groupId, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMFormInstance> orderByComparator)
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long groupId, String keywords)
    • searchCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long groupId, String[] names, String[] descriptions, boolean andOperator)
    • sendEmail

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

      @Indexable(type=REINDEX) 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

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

      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

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

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

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