com.liferay.dynamic.data.mapping.service

Interface DDMStructureLayoutLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

DDMStructureLayoutLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DDMStructureLayoutLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

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

DDMStructureLayoutLocalServiceUtil, com.liferay.dynamic.data.mapping.service.base.DDMStructureLayoutLocalServiceBaseImpl, com.liferay.dynamic.data.mapping.service.impl.DDMStructureLayoutLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
DDMStructureLayout	addDDMStructureLayout(DDMStructureLayout ddmStructureLayout) Adds the ddm structure layout to the database.
DDMStructureLayout	addStructureLayout(long userId, long groupId, long structureVersionId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext)
DDMStructureLayout	createDDMStructureLayout(long structureLayoutId) Creates a new ddm structure layout with the primary key.
DDMStructureLayout	deleteDDMStructureLayout(DDMStructureLayout ddmStructureLayout) Deletes the ddm structure layout from the database.
DDMStructureLayout	deleteDDMStructureLayout(long structureLayoutId) Deletes the ddm structure layout with the primary key from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
void	deleteStructureLayout(DDMStructureLayout structureLayout)
void	deleteStructureLayout(long structureLayoutId)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.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.
<T> java.util.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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
DDMStructureLayout	fetchDDMStructureLayout(long structureLayoutId)
DDMStructureLayout	fetchDDMStructureLayoutByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the ddm structure layout matching the UUID and group.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
DDMStructureLayout	getDDMStructureLayout(long structureLayoutId) Returns the ddm structure layout with the primary key.
DDMStructureLayout	getDDMStructureLayoutByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the ddm structure layout matching the UUID and group.
java.util.List<DDMStructureLayout>	getDDMStructureLayouts(int start, int end) Returns a range of all the ddm structure layouts.
java.util.List<DDMStructureLayout>	getDDMStructureLayoutsByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the ddm structure layouts matching the UUID and company.
java.util.List<DDMStructureLayout>	getDDMStructureLayoutsByUuidAndCompanyId(java.lang.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.
int	getDDMStructureLayoutsCount() Returns the number of ddm structure layouts.
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
DDMStructureLayout	getStructureLayout(long structureLayoutId)
DDMStructureLayout	getStructureLayoutByStructureVersionId(long structureVersionId)
DDMFormLayout	getStructureLayoutDDMFormLayout(DDMStructureLayout structureLayout)
DDMStructureLayout	updateDDMStructureLayout(DDMStructureLayout ddmStructureLayout) Updates the ddm structure layout in the database or adds it if it does not yet exist.
DDMStructureLayout	updateStructureLayout(long structureLayoutId, DDMFormLayout ddmFormLayout, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Method Detail

getStructureLayoutDDMFormLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMFormLayout getStructureLayoutDDMFormLayout(DDMStructureLayout structureLayout)
                                                                                                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addDDMStructureLayout

@Indexable(type=REINDEX)
DDMStructureLayout addDDMStructureLayout(DDMStructureLayout ddmStructureLayout)

Adds the ddm structure layout to the database. Also notifies the appropriate model listeners.

Parameters:

ddmStructureLayout - the ddm structure layout

Returns:

the ddm structure layout that was added

addStructureLayout

DDMStructureLayout addStructureLayout(long userId,
                                      long groupId,
                                      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

createDDMStructureLayout

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

deleteDDMStructureLayout

@Indexable(type=DELETE)
DDMStructureLayout deleteDDMStructureLayout(DDMStructureLayout ddmStructureLayout)

Deletes the ddm structure layout from the database. Also notifies the appropriate model listeners.

Parameters:

ddmStructureLayout - the ddm structure layout

Returns:

the ddm structure layout that was removed

deleteDDMStructureLayout

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

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

fetchDDMStructureLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructureLayout fetchDDMStructureLayout(long structureLayoutId)

fetchDDMStructureLayoutByUuidAndGroupId

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

getDDMStructureLayout

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructureLayout getDDMStructureLayoutByUuidAndGroupId(java.lang.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 UUID

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

getStructureLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructureLayout getStructureLayout(long structureLayoutId)
                                                                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getStructureLayoutByStructureVersionId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructureLayout getStructureLayoutByStructureVersionId(long structureVersionId)
                                                                                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateDDMStructureLayout

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

Parameters:

ddmStructureLayout - the ddm structure layout

Returns:

the ddm structure layout that was updated

updateStructureLayout

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

getActionableDynamicQuery

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

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

getExportActionableDynamicQuery

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

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

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

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.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

getDDMStructureLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDDMStructureLayoutsCount()

Returns the number of ddm structure layouts.

Returns:

the number of ddm structure layouts

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

dynamicQuery

<T> java.util.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

<T> java.util.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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DDMStructureLayoutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

<T> java.util.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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DDMStructureLayoutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

getDDMStructureLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DDMStructureLayoutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(java.lang.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 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

dynamicQueryCount

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

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

deleteStructureLayout

@SystemEvent(type=1)
void deleteStructureLayout(DDMStructureLayout structureLayout)

deleteStructureLayout

void deleteStructureLayout(long structureLayoutId)
                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException