Class DDMFormInstanceLocalServiceUtil
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DDMFormInstance
addDDMFormInstance
(DDMFormInstance ddmFormInstance) Adds the ddm form instance to the database.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) 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) 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) static void
addFormInstanceResources
(DDMFormInstance ddmFormInstance, boolean addGroupPermissions, boolean addGuestPermissions) static void
addFormInstanceResources
(DDMFormInstance ddmFormInstance, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) static DDMFormInstance
copyFormInstance
(long userId, long groupId, Map<Locale, String> nameMap, DDMFormInstance sourceDDMFormInstance, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMFormInstance
createDDMFormInstance
(long formInstanceId) Creates a new ddm form instance with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static DDMFormInstance
deleteDDMFormInstance
(long formInstanceId) Deletes the ddm form instance with the primary key from the database.static DDMFormInstance
deleteDDMFormInstance
(DDMFormInstance ddmFormInstance) Deletes the ddm form instance from the database.static void
deleteFormInstance
(long ddmFormInstanceId) static void
deleteFormInstance
(DDMFormInstance ddmFormInstance) static void
deleteFormInstances
(long groupId) static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
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.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 long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.static DDMFormInstance
fetchDDMFormInstance
(long formInstanceId) static DDMFormInstance
fetchDDMFormInstanceByUuidAndGroupId
(String uuid, long groupId) Returns the ddm form instance matching the UUID and group.static DDMFormInstance
fetchFormInstance
(long ddmFormInstanceId) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static DDMFormInstance
getDDMFormInstance
(long formInstanceId) Returns the ddm form instance with the primary key.static DDMFormInstance
getDDMFormInstanceByUuidAndGroupId
(String uuid, long groupId) Returns the ddm form instance matching the UUID and group.static List<DDMFormInstance>
getDDMFormInstances
(int start, int end) Returns a range of all the ddm form instances.static List<DDMFormInstance>
getDDMFormInstancesByUuidAndCompanyId
(String uuid, long companyId) Returns all the ddm form instances matching the UUID and company.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.static int
Returns the number of ddm form instances.static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static DDMFormInstance
getFormInstance
(long ddmFormInstanceId) static DDMFormInstance
getFormInstance
(String uuid, long ddmFormInstanceId) static DDMFormInstance
getFormInstanceByStructureId
(long structureId) static List<DDMFormInstance>
getFormInstances
(long groupId) static int
getFormInstancesCount
(long groupId) static int
getFormInstancesCount
(String uuid) static DDMFormValues
getFormInstanceSettingsFormValues
(DDMFormInstance formInstance) static DDMFormInstanceSettings
getFormInstanceSettingsModel
(DDMFormInstance formInstance) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static DDMFormInstanceLocalService
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) static List<DDMFormInstance>
search
(long companyId, long groupId, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMFormInstance> orderByComparator) static int
searchCount
(long companyId, long groupId, String keywords) static int
searchCount
(long companyId, long groupId, String[] names, String[] descriptions, boolean andOperator) static void
static DDMFormInstance
updateDDMFormInstance
(DDMFormInstance ddmFormInstance) Updates the ddm form instance in the database or adds it if it does not yet exist.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) static DDMFormInstance
updateFormInstance
(long ddmFormInstanceId, long ddmStructureId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMFormInstance
updateFormInstance
(long formInstanceId, DDMFormValues settingsDDMFormValues)
-
Constructor Details
-
DDMFormInstanceLocalServiceUtil
public DDMFormInstanceLocalServiceUtil()
-
-
Method Details
-
addDDMFormInstance
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, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addFormInstance
public static DDMFormInstance addFormInstance(long userId, long groupId, long ddmStructureId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String serializedSettingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addFormInstance
public static DDMFormInstance addFormInstance(long userId, long groupId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) - 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
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
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
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.mapping.model.impl.DDMFormInstanceModelImpl
.- 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.mapping.model.impl.DDMFormInstanceModelImpl
.- 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
-
fetchDDMFormInstance
-
fetchDDMFormInstanceByUuidAndGroupId
Returns the ddm form instance matching the UUID and group.- Parameters:
uuid
- the ddm form instance's UUIDgroupId
- 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
-
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 UUIDgroupId
- 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
Returns a range of all the ddm form instances.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.mapping.model.impl.DDMFormInstanceModelImpl
.- Parameters:
start
- the lower bound of the range of ddm form instancesend
- 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 instancescompanyId
- 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 instancescompanyId
- the primary key of the companystart
- the lower bound of the range of ddm form instancesend
- the upper bound of the range of ddm form instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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
-
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
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
-
searchCount
-
sendEmail
public static void sendEmail(long userId, String message, String subject, String[] toEmailAddresses) throws Exception - Throws:
Exception
-
updateDDMFormInstance
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, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, DDMForm ddmForm, DDMFormLayout ddmFormLayout, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateFormInstance
public static DDMFormInstance updateFormInstance(long ddmFormInstanceId, long ddmStructureId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, DDMFormValues settingsDDMFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-