com.liferay.dynamic.data.mapping.service

Class DDMStructureLayoutLocalServiceUtil

java.lang.Object

com.liferay.dynamic.data.mapping.service.DDMStructureLayoutLocalServiceUtil

public class DDMStructureLayoutLocalServiceUtil
extends java.lang.Object

Provides the local service utility for DDMStructureLayout. This utility wraps 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:

DDMStructureLayoutLocalService

Constructor Summary

Constructors

Constructor and Description
DDMStructureLayoutLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DDMStructureLayout	addDDMStructureLayout(DDMStructureLayout ddmStructureLayout) Adds the ddm structure layout to the database.
static DDMStructureLayout	addStructureLayout(long userId, long groupId, long structureVersionId, DDMFormLayout ddmFormLayout, ServiceContext serviceContext) Deprecated. As of Athanasius (7.3.x), replaced by addStructureLayout(long, long, long, String, long, DDMFormLayout, ServiceContext)
static DDMStructureLayout	addStructureLayout(long userId, long groupId, long classNameId, java.lang.String structureLayoutKey, long structureVersionId, DDMFormLayout ddmFormLayout, ServiceContext serviceContext)
static DDMStructureLayout	addStructureLayout(long userId, long groupId, long classNameId, java.lang.String structureLayoutKey, long structureVersionId, java.util.Map<java.util.Locale,java.lang.String> name, java.util.Map<java.util.Locale,java.lang.String> description, java.lang.String definition, ServiceContext serviceContext)
static DDMStructureLayout	createDDMStructureLayout(long structureLayoutId) Creates a new ddm structure layout with the primary key.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static DDMStructureLayout	deleteDDMStructureLayout(DDMStructureLayout ddmStructureLayout) Deletes the ddm structure layout from the database.
static DDMStructureLayout	deleteDDMStructureLayout(long structureLayoutId) Deletes the ddm structure layout with the primary key from the database.
static void	deleteDDMStructureLayouts(long classNameId, DDMStructureVersion ddmStructureVersion)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static void	deleteStructureLayout(DDMStructureLayout structureLayout)
static void	deleteStructureLayout(long structureLayoutId)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static DDMStructureLayout	fetchDDMStructureLayout(long structureLayoutId)
static DDMStructureLayout	fetchDDMStructureLayoutByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the ddm structure layout matching the UUID and group.
static DDMStructureLayout	fetchStructureLayout(long structureLayoutId)
static DDMStructureLayout	fetchStructureLayout(long groupId, long classNameId, java.lang.String structureLayoutKey)
static ActionableDynamicQuery	getActionableDynamicQuery()
static DDMStructureLayout	getDDMStructureLayout(long structureLayoutId) Returns the ddm structure layout with the primary key.
static DDMStructureLayout	getDDMStructureLayoutByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the ddm structure layout matching the UUID and group.
static java.util.List<DDMStructureLayout>	getDDMStructureLayouts(int start, int end) Returns a range of all the ddm structure layouts.
static java.util.List<DDMStructureLayout>	getDDMStructureLayoutsByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the ddm structure layouts matching the UUID and company.
static java.util.List<DDMStructureLayout>	getDDMStructureLayoutsByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, OrderByComparator<DDMStructureLayout> orderByComparator) Returns a range of ddm structure layouts matching the UUID and company.
static int	getDDMStructureLayoutsCount() Returns the number of ddm structure layouts.
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static DDMStructureLayoutLocalService	getService()
static DDMStructureLayout	getStructureLayout(long structureLayoutId)
static DDMStructureLayout	getStructureLayout(long groupId, long classNameId, java.lang.String structureLayoutKey)
static DDMStructureLayout	getStructureLayoutByStructureVersionId(long structureVersionId)
static DDMFormLayout	getStructureLayoutDDMFormLayout(DDMStructureLayout structureLayout)
static java.util.List<DDMStructureLayout>	getStructureLayouts(long groupId, int start, int end)
static java.util.List<DDMStructureLayout>	getStructureLayouts(long groupId, long classNameId, int start, int end, OrderByComparator<DDMStructureLayout> orderByComparator)
static java.util.List<DDMStructureLayout>	getStructureLayouts(long groupId, long classNameId, long structureVersionId)
static java.util.List<DDMStructureLayout>	getStructureLayouts(long groupId, long classNameId, long structureVersionId, int start, int end, OrderByComparator<DDMStructureLayout> orderByComparator)
static int	getStructureLayoutsCount(long groupId)
static int	getStructureLayoutsCount(long groupId, long classNameId)
static int	getStructureLayoutsCount(long groupId, long classNameId, long structureVersionId)
static java.util.List<DDMStructureLayout>	search(long companyId, long[] groupIds, long classNameId, java.lang.String keywords, int start, int end, OrderByComparator<DDMStructureLayout> orderByComparator)
static int	searchCount(long companyId, long[] groupIds, long classNameId, java.lang.String keywords)
static DDMStructureLayout	updateDDMStructureLayout(DDMStructureLayout ddmStructureLayout) Updates the ddm structure layout in the database or adds it if it does not yet exist.
static DDMStructureLayout	updateStructureLayout(long structureLayoutId, DDMFormLayout ddmFormLayout, ServiceContext serviceContext)
static DDMStructureLayout	updateStructureLayout(long structureLayoutId, long structureVersionId, java.util.Map<java.util.Locale,java.lang.String> name, java.util.Map<java.util.Locale,java.lang.String> description, java.lang.String definition, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DDMStructureLayoutLocalServiceUtil

public DDMStructureLayoutLocalServiceUtil()

Method Detail

addDDMStructureLayout

public static DDMStructureLayout addDDMStructureLayout(DDMStructureLayout ddmStructureLayout)

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,
                                                                ServiceContext serviceContext)
                                                         throws PortalException

Deprecated. As of Athanasius (7.3.x), replaced by addStructureLayout(long, long, long, String, long, DDMFormLayout, ServiceContext)

Throws:

PortalException

addStructureLayout

public static DDMStructureLayout addStructureLayout(long userId,
                                                    long groupId,
                                                    long classNameId,
                                                    java.lang.String structureLayoutKey,
                                                    long structureVersionId,
                                                    DDMFormLayout ddmFormLayout,
                                                    ServiceContext serviceContext)
                                             throws PortalException

Throws:

PortalException

addStructureLayout

public static DDMStructureLayout addStructureLayout(long userId,
                                                    long groupId,
                                                    long classNameId,
                                                    java.lang.String structureLayoutKey,
                                                    long structureVersionId,
                                                    java.util.Map<java.util.Locale,java.lang.String> name,
                                                    java.util.Map<java.util.Locale,java.lang.String> description,
                                                    java.lang.String definition,
                                                    ServiceContext serviceContext)
                                             throws PortalException

Throws:

PortalException

createDDMStructureLayout

public static DDMStructureLayout createDDMStructureLayout(long structureLayoutId)

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 PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteDDMStructureLayout

public static DDMStructureLayout deleteDDMStructureLayout(DDMStructureLayout ddmStructureLayout)

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 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:

PortalException - if a ddm structure layout with the primary key could not be found

deleteDDMStructureLayouts

public static void deleteDDMStructureLayouts(long classNameId,
                                             DDMStructureVersion ddmStructureVersion)
                                      throws PortalException

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteStructureLayout

public static void deleteStructureLayout(DDMStructureLayout structureLayout)

deleteStructureLayout

public static void deleteStructureLayout(long structureLayoutId)
                                  throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> 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> java.util.List<T> dynamicQuery(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.DDMStructureLayoutModelImpl.

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> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 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.DDMStructureLayoutModelImpl.

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(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(DynamicQuery dynamicQuery,
                                     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

fetchDDMStructureLayout

public static DDMStructureLayout fetchDDMStructureLayout(long structureLayoutId)

fetchDDMStructureLayoutByUuidAndGroupId

public static DDMStructureLayout fetchDDMStructureLayoutByUuidAndGroupId(java.lang.String uuid,
                                                                         long groupId)

Returns the ddm structure layout matching the UUID and group.

Parameters:

uuid - the ddm structure layout's UUID

groupId - the primary key of the group

Returns:

the matching ddm structure layout, or null if a matching ddm structure layout could not be found

fetchStructureLayout

public static DDMStructureLayout fetchStructureLayout(long structureLayoutId)

fetchStructureLayout

public static DDMStructureLayout fetchStructureLayout(long groupId,
                                                      long classNameId,
                                                      java.lang.String structureLayoutKey)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDDMStructureLayout

public static DDMStructureLayout getDDMStructureLayout(long structureLayoutId)
                                                throws 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:

PortalException - if a ddm structure layout with the primary key could not be found

getDDMStructureLayoutByUuidAndGroupId

public static DDMStructureLayout getDDMStructureLayoutByUuidAndGroupId(java.lang.String uuid,
                                                                       long groupId)
                                                                throws PortalException

Returns the ddm structure layout matching the UUID and group.

Parameters:

uuid - the ddm structure layout's UUID

groupId - the primary key of the group

Returns:

the matching ddm structure layout

Throws:

PortalException - if a matching ddm structure layout could not be found

getDDMStructureLayouts

public static java.util.List<DDMStructureLayout> getDDMStructureLayouts(int start,
                                                                        int end)

Returns a range of all the ddm structure layouts.

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

Parameters:

start - the lower bound of the range of ddm structure layouts

end - the upper bound of the range of ddm structure layouts (not inclusive)

Returns:

the range of ddm structure layouts

getDDMStructureLayoutsByUuidAndCompanyId

public static java.util.List<DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(java.lang.String uuid,
                                                                                          long companyId)

Returns all the ddm structure layouts matching the UUID and company.

Parameters:

uuid - the UUID of the ddm structure layouts

companyId - the primary key of the company

Returns:

the matching ddm structure layouts, or an empty list if no matches were found

getDDMStructureLayoutsByUuidAndCompanyId

public static java.util.List<DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(java.lang.String uuid,
                                                                                          long companyId,
                                                                                          int start,
                                                                                          int end,
                                                                                          OrderByComparator<DDMStructureLayout> orderByComparator)

Returns a range of ddm structure layouts matching the UUID and company.

Parameters:

uuid - the UUID of the ddm structure layouts

companyId - the primary key of the company

start - the lower bound of the range of ddm structure layouts

end - the upper bound of the range of ddm structure layouts (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

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 ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getStructureLayout

public static DDMStructureLayout getStructureLayout(long structureLayoutId)
                                             throws PortalException

Throws:

PortalException

getStructureLayout

public static DDMStructureLayout getStructureLayout(long groupId,
                                                    long classNameId,
                                                    java.lang.String structureLayoutKey)
                                             throws PortalException

Throws:

PortalException

getStructureLayoutByStructureVersionId

public static DDMStructureLayout getStructureLayoutByStructureVersionId(long structureVersionId)
                                                                 throws PortalException

Throws:

PortalException

getStructureLayoutDDMFormLayout

public static DDMFormLayout getStructureLayoutDDMFormLayout(DDMStructureLayout structureLayout)

getStructureLayouts

public static java.util.List<DDMStructureLayout> getStructureLayouts(long groupId,
                                                                     int start,
                                                                     int end)
                                                              throws PortalException

Throws:

PortalException

getStructureLayouts

public static java.util.List<DDMStructureLayout> getStructureLayouts(long groupId,
                                                                     long classNameId,
                                                                     int start,
                                                                     int end,
                                                                     OrderByComparator<DDMStructureLayout> orderByComparator)

getStructureLayouts

public static java.util.List<DDMStructureLayout> getStructureLayouts(long groupId,
                                                                     long classNameId,
                                                                     long structureVersionId)

getStructureLayouts

public static java.util.List<DDMStructureLayout> getStructureLayouts(long groupId,
                                                                     long classNameId,
                                                                     long structureVersionId,
                                                                     int start,
                                                                     int end,
                                                                     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 java.util.List<DDMStructureLayout> search(long companyId,
                                                        long[] groupIds,
                                                        long classNameId,
                                                        java.lang.String keywords,
                                                        int start,
                                                        int end,
                                                        OrderByComparator<DDMStructureLayout> orderByComparator)
                                                 throws PortalException

Throws:

PortalException

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long classNameId,
                              java.lang.String keywords)
                       throws PortalException

Throws:

PortalException

updateDDMStructureLayout

public static DDMStructureLayout updateDDMStructureLayout(DDMStructureLayout ddmStructureLayout)

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,
                                                       ServiceContext serviceContext)
                                                throws PortalException

Throws:

PortalException

updateStructureLayout

public static DDMStructureLayout updateStructureLayout(long structureLayoutId,
                                                       long structureVersionId,
                                                       java.util.Map<java.util.Locale,java.lang.String> name,
                                                       java.util.Map<java.util.Locale,java.lang.String> description,
                                                       java.lang.String definition,
                                                       ServiceContext serviceContext)
                                                throws PortalException

Throws:

PortalException

getService

public static DDMStructureLayoutLocalService getService()