Class DDMStructureLayoutLocalServiceUtil
com.liferay.dynamic.data.mapping.service.impl.DDMStructureLayoutLocalServiceImpl 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 DDMStructureLayoutaddDDMStructureLayout(DDMStructureLayout ddmStructureLayout) Adds the ddm structure layout to the database.static DDMStructureLayoutaddStructureLayout(long userId, long groupId, long structureVersionId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated.static DDMStructureLayoutaddStructureLayout(long userId, long groupId, long classNameId, String structureLayoutKey, long structureVersionId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMStructureLayoutaddStructureLayout(long userId, long groupId, long classNameId, String structureLayoutKey, long structureVersionId, Map<Locale, String> name, Map<Locale, String> description, String definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMStructureLayoutcreateDDMStructureLayout(long structureLayoutId) Creates a new ddm structure layout with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static DDMStructureLayoutdeleteDDMStructureLayout(long structureLayoutId) Deletes the ddm structure layout with the primary key from the database.static DDMStructureLayoutdeleteDDMStructureLayout(DDMStructureLayout ddmStructureLayout) Deletes the ddm structure layout from the database.static voiddeleteDDMStructureLayouts(long classNameId, DDMStructureVersion ddmStructureVersion) static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static voiddeleteStructureLayout(long structureLayoutId) static voiddeleteStructureLayout(DDMStructureLayout structureLayout) 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 DDMStructureLayoutfetchDDMStructureLayout(long structureLayoutId) static DDMStructureLayoutfetchDDMStructureLayoutByUuidAndGroupId(String uuid, long groupId) Returns the ddm structure layout matching the UUID and group.static DDMStructureLayoutfetchStructureLayout(long structureLayoutId) static DDMStructureLayoutfetchStructureLayout(long groupId, long classNameId, String structureLayoutKey) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic DDMStructureLayoutgetDDMStructureLayout(long structureLayoutId) Returns the ddm structure layout with the primary key.static DDMStructureLayoutgetDDMStructureLayoutByUuidAndGroupId(String uuid, long groupId) Returns the ddm structure layout matching the UUID and group.static List<DDMStructureLayout>getDDMStructureLayouts(int start, int end) Returns a range of all the ddm structure layouts.static List<DDMStructureLayout>getDDMStructureLayoutsByUuidAndCompanyId(String uuid, long companyId) Returns all the ddm structure layouts matching the UUID and company.static List<DDMStructureLayout>getDDMStructureLayoutsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructureLayout> orderByComparator) Returns a range of ddm structure layouts matching the UUID and company.static intReturns the number of ddm structure layouts.static 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 DDMStructureLayoutgetStructureLayout(long structureLayoutId) static DDMStructureLayoutgetStructureLayout(long groupId, long classNameId, String structureLayoutKey) static DDMStructureLayoutgetStructureLayoutByStructureVersionId(long structureVersionId) static DDMFormLayoutgetStructureLayoutDDMFormLayout(DDMStructureLayout structureLayout) static List<DDMStructureLayout>getStructureLayouts(long groupId, int start, int end) static List<DDMStructureLayout>getStructureLayouts(long groupId, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructureLayout> orderByComparator) static List<DDMStructureLayout>getStructureLayouts(long groupId, long classNameId, long structureVersionId) static List<DDMStructureLayout>getStructureLayouts(long groupId, long classNameId, long structureVersionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructureLayout> orderByComparator) static intgetStructureLayoutsCount(long groupId) static intgetStructureLayoutsCount(long groupId, long classNameId) static intgetStructureLayoutsCount(long groupId, long classNameId, long structureVersionId) static List<DDMStructureLayout>search(long companyId, long[] groupIds, long classNameId, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructureLayout> orderByComparator) static intsearchCount(long companyId, long[] groupIds, long classNameId, String keywords) static DDMStructureLayoutupdateDDMStructureLayout(DDMStructureLayout ddmStructureLayout) Updates the ddm structure layout in the database or adds it if it does not yet exist.static DDMStructureLayoutupdateStructureLayout(long structureLayoutId, long structureVersionId, Map<Locale, String> name, Map<Locale, String> description, String definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) static DDMStructureLayoutupdateStructureLayout(long structureLayoutId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext)
-
Constructor Details
-
DDMStructureLayoutLocalServiceUtil
public DDMStructureLayoutLocalServiceUtil()
-
-
Method Details
-
addDDMStructureLayout
Adds the ddm structure layout to the database. Also notifies the appropriate model listeners.Important: Inspect DDMStructureLayoutLocalServiceImpl 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:
ddmStructureLayout- the ddm structure layout- Returns:
- the ddm structure layout that was added
-
addStructureLayout
@Deprecated public static DDMStructureLayout addStructureLayout(long userId, long groupId, long structureVersionId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Deprecated.As of Athanasius (7.3.x), replaced byaddStructureLayout(long, long, long, String, long, DDMFormLayout, ServiceContext)- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addStructureLayout
public static DDMStructureLayout addStructureLayout(long userId, long groupId, long classNameId, String structureLayoutKey, long structureVersionId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addStructureLayout
public static DDMStructureLayout addStructureLayout(long userId, long groupId, long classNameId, String structureLayoutKey, long structureVersionId, Map<Locale, String> name, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> description, String definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createDDMStructureLayout
Creates a new ddm structure layout with the primary key. Does not add the ddm structure layout to the database.- Parameters:
structureLayoutId- the primary key for the new ddm structure layout- Returns:
- the new ddm structure layout
-
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
-
deleteDDMStructureLayout
Deletes the ddm structure layout from the database. Also notifies the appropriate model listeners.Important: Inspect DDMStructureLayoutLocalServiceImpl 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:
ddmStructureLayout- the ddm structure layout- Returns:
- the ddm structure layout that was removed
-
deleteDDMStructureLayout
public static DDMStructureLayout deleteDDMStructureLayout(long structureLayoutId) throws com.liferay.portal.kernel.exception.PortalException Deletes the ddm structure layout with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DDMStructureLayoutLocalServiceImpl 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:
structureLayoutId- the primary key of the ddm structure layout- Returns:
- the ddm structure layout that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a ddm structure layout with the primary key could not be found
-
deleteDDMStructureLayouts
public static void deleteDDMStructureLayouts(long classNameId, DDMStructureVersion ddmStructureVersion) 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
-
deleteStructureLayout
-
deleteStructureLayout
public static void deleteStructureLayout(long structureLayoutId) 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 - 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.dynamic.data.mapping.model.impl.DDMStructureLayoutModelImpl.- 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.dynamic.data.mapping.model.impl.DDMStructureLayoutModelImpl.- 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
-
fetchDDMStructureLayout
-
fetchDDMStructureLayoutByUuidAndGroupId
Returns the ddm structure layout matching the UUID and group.- Parameters:
uuid- the ddm structure layout's UUIDgroupId- the primary key of the group- Returns:
- the matching ddm structure layout, or
nullif a matching ddm structure layout could not be found
-
fetchStructureLayout
-
fetchStructureLayout
public static DDMStructureLayout fetchStructureLayout(long groupId, long classNameId, String structureLayoutKey) -
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getDDMStructureLayout
public static DDMStructureLayout getDDMStructureLayout(long structureLayoutId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddm structure layout with the primary key.- Parameters:
structureLayoutId- the primary key of the ddm structure layout- Returns:
- the ddm structure layout
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a ddm structure layout with the primary key could not be found
-
getDDMStructureLayoutByUuidAndGroupId
public static DDMStructureLayout getDDMStructureLayoutByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddm structure layout matching the UUID and group.- Parameters:
uuid- the ddm structure layout's UUIDgroupId- the primary key of the group- Returns:
- the matching ddm structure layout
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a matching ddm structure layout could not be found
-
getDDMStructureLayouts
Returns a range of all the ddm structure layouts.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.dynamic.data.mapping.model.impl.DDMStructureLayoutModelImpl.- Parameters:
start- the lower bound of the range of ddm structure layoutsend- the upper bound of the range of ddm structure layouts (not inclusive)- Returns:
- the range of ddm structure layouts
-
getDDMStructureLayoutsByUuidAndCompanyId
public static List<DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(String uuid, long companyId) Returns all the ddm structure layouts matching the UUID and company.- Parameters:
uuid- the UUID of the ddm structure layoutscompanyId- the primary key of the company- Returns:
- the matching ddm structure layouts, or an empty list if no matches were found
-
getDDMStructureLayoutsByUuidAndCompanyId
public static List<DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructureLayout> orderByComparator) Returns a range of ddm structure layouts matching the UUID and company.- Parameters:
uuid- the UUID of the ddm structure layoutscompanyId- the primary key of the companystart- the lower bound of the range of ddm structure layoutsend- the upper bound of the range of ddm structure layouts (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the range of matching ddm structure layouts, or an empty list if no matches were found
-
getDDMStructureLayoutsCount
public static int getDDMStructureLayoutsCount()Returns the number of ddm structure layouts.- Returns:
- the number of ddm structure layouts
-
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
-
getStructureLayout
public static DDMStructureLayout getStructureLayout(long structureLayoutId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructureLayout
public static DDMStructureLayout getStructureLayout(long groupId, long classNameId, String structureLayoutKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructureLayoutByStructureVersionId
public static DDMStructureLayout getStructureLayoutByStructureVersionId(long structureVersionId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructureLayoutDDMFormLayout
-
getStructureLayouts
public static List<DDMStructureLayout> getStructureLayouts(long groupId, int start, int end) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getStructureLayouts
public static List<DDMStructureLayout> getStructureLayouts(long groupId, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructureLayout> orderByComparator) -
getStructureLayouts
public static List<DDMStructureLayout> getStructureLayouts(long groupId, long classNameId, long structureVersionId) -
getStructureLayouts
public static List<DDMStructureLayout> getStructureLayouts(long groupId, long classNameId, long structureVersionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructureLayout> orderByComparator) -
getStructureLayoutsCount
public static int getStructureLayoutsCount(long groupId) -
getStructureLayoutsCount
public static int getStructureLayoutsCount(long groupId, long classNameId) -
getStructureLayoutsCount
public static int getStructureLayoutsCount(long groupId, long classNameId, long structureVersionId) -
search
public static List<DDMStructureLayout> search(long companyId, long[] groupIds, long classNameId, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDMStructureLayout> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
searchCount
public static int searchCount(long companyId, long[] groupIds, long classNameId, String keywords) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateDDMStructureLayout
Updates the ddm structure layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect DDMStructureLayoutLocalServiceImpl 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:
ddmStructureLayout- the ddm structure layout- Returns:
- the ddm structure layout that was updated
-
updateStructureLayout
public static DDMStructureLayout updateStructureLayout(long structureLayoutId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStructureLayout
public static DDMStructureLayout updateStructureLayout(long structureLayoutId, long structureVersionId, Map<Locale, String> name, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> description, String definition, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-
addStructureLayout(long, long, long, String, long, DDMFormLayout, ServiceContext)