Liferay 7.0-ce-m6

com.liferay.portlet.dynamicdatamapping.service
Interface DDMStructureLayoutLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
DDMStructureLayoutLocalServiceBaseImpl, DDMStructureLayoutLocalServiceImpl, DDMStructureLayoutLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DDMStructureLayoutLocalService
extends BaseLocalService, 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, DDMStructureLayoutLocalServiceBaseImpl, DDMStructureLayoutLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 DDMStructureLayout addDDMStructureLayout(DDMStructureLayout ddmStructureLayout)
          Adds the d d m structure layout to the database.
 DDMStructureLayout addStructureLayout(long userId, long groupId, long structureVersionId, DDMFormLayout ddmFormLayout, ServiceContext serviceContext)
           
 DDMStructureLayout createDDMStructureLayout(long structureLayoutId)
          Creates a new d d m structure layout with the primary key.
 DDMStructureLayout deleteDDMStructureLayout(DDMStructureLayout ddmStructureLayout)
          Deletes the d d m structure layout from the database.
 DDMStructureLayout deleteDDMStructureLayout(long structureLayoutId)
          Deletes the d d m structure layout with the primary key from the database.
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 void deleteStructureLayout(DDMStructureLayout structureLayout)
           
 void deleteStructureLayout(long structureLayoutId)
           
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
<T> 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 DDMStructureLayout fetchDDMStructureLayout(long structureLayoutId)
           
 DDMStructureLayout fetchDDMStructureLayoutByUuidAndGroupId(String uuid, long groupId)
          Returns the d d m structure layout matching the UUID and group.
 ActionableDynamicQuery getActionableDynamicQuery()
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 DDMStructureLayout getDDMStructureLayout(long structureLayoutId)
          Returns the d d m structure layout with the primary key.
 DDMStructureLayout getDDMStructureLayoutByUuidAndGroupId(String uuid, long groupId)
          Returns the d d m structure layout matching the UUID and group.
 List<DDMStructureLayout> getDDMStructureLayouts(int start, int end)
          Returns a range of all the d d m structure layouts.
 List<DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(String uuid, long companyId)
          Returns all the d d m structure layouts matching the UUID and company.
 List<DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<DDMStructureLayout> orderByComparator)
          Returns a range of d d m structure layouts matching the UUID and company.
 int getDDMStructureLayoutsCount()
          Returns the number of d d m structure layouts.
 ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 DDMStructureLayout getStructureLayout(long structureLayoutId)
           
 DDMStructureLayout getStructureLayoutByStructureVersionId(long structureVersionId)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 DDMStructureLayout updateDDMStructureLayout(DDMStructureLayout ddmStructureLayout)
          Updates the d d m structure layout in the database or adds it if it does not yet exist.
 DDMStructureLayout updateStructureLayout(long structureLayoutId, DDMFormLayout ddmFormLayout, ServiceContext serviceContext)
           
 

Method Detail

addDDMStructureLayout

@Indexable(type=REINDEX)
DDMStructureLayout addDDMStructureLayout(DDMStructureLayout ddmStructureLayout)
Adds the d d m structure layout to the database. Also notifies the appropriate model listeners.

Parameters:
ddmStructureLayout - the d d m structure layout
Returns:
the d d m structure layout that was added

addStructureLayout

DDMStructureLayout addStructureLayout(long userId,
                                      long groupId,
                                      long structureVersionId,
                                      DDMFormLayout ddmFormLayout,
                                      ServiceContext serviceContext)
                                      throws PortalException
Throws:
PortalException

createDDMStructureLayout

DDMStructureLayout createDDMStructureLayout(long structureLayoutId)
Creates a new d d m structure layout with the primary key. Does not add the d d m structure layout to the database.

Parameters:
structureLayoutId - the primary key for the new d d m structure layout
Returns:
the new d d m structure layout

deleteDDMStructureLayout

@Indexable(type=DELETE)
DDMStructureLayout deleteDDMStructureLayout(DDMStructureLayout ddmStructureLayout)
Deletes the d d m structure layout from the database. Also notifies the appropriate model listeners.

Parameters:
ddmStructureLayout - the d d m structure layout
Returns:
the d d m structure layout that was removed

deleteDDMStructureLayout

@Indexable(type=DELETE)
DDMStructureLayout deleteDDMStructureLayout(long structureLayoutId)
                                            throws PortalException
Deletes the d d m structure layout with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
structureLayoutId - the primary key of the d d m structure layout
Returns:
the d d m structure layout that was removed
Throws:
PortalException - if a d d m structure layout with the primary key could not be found

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteStructureLayout

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

deleteStructureLayout

void deleteStructureLayout(long structureLayoutId)
                           throws PortalException
Throws:
PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

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

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

dynamicQueryCount

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

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

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

fetchDDMStructureLayoutByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructureLayout fetchDDMStructureLayoutByUuidAndGroupId(String uuid,
                                                                                                    long groupId)
Returns the d d m structure layout matching the UUID and group.

Parameters:
uuid - the d d m structure layout's UUID
groupId - the primary key of the group
Returns:
the matching d d m structure layout, or null if a matching d d m structure layout could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

getDDMStructureLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructureLayout getDDMStructureLayout(long structureLayoutId)
                                         throws PortalException
Returns the d d m structure layout with the primary key.

Parameters:
structureLayoutId - the primary key of the d d m structure layout
Returns:
the d d m structure layout
Throws:
PortalException - if a d d m structure layout with the primary key could not be found

getDDMStructureLayoutByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructureLayout getDDMStructureLayoutByUuidAndGroupId(String uuid,
                                                                                                  long groupId)
                                                         throws PortalException
Returns the d d m structure layout matching the UUID and group.

Parameters:
uuid - the d d m structure layout's UUID
groupId - the primary key of the group
Returns:
the matching d d m structure layout
Throws:
PortalException - if a matching d d m structure layout could not be found

getDDMStructureLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructureLayout> getDDMStructureLayouts(int start,
                                                                                         int end)
Returns a range of all the d d m 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 d d m structure layouts
end - the upper bound of the range of d d m structure layouts (not inclusive)
Returns:
the range of d d m structure layouts

getDDMStructureLayoutsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(String uuid,
                                                                                                           long companyId)
Returns all the d d m structure layouts matching the UUID and company.

Parameters:
uuid - the UUID of the d d m structure layouts
companyId - the primary key of the company
Returns:
the matching d d m structure layouts, or an empty list if no matches were found

getDDMStructureLayoutsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDMStructureLayout> getDDMStructureLayoutsByUuidAndCompanyId(String uuid,
                                                                                                           long companyId,
                                                                                                           int start,
                                                                                                           int end,
                                                                                                           OrderByComparator<DDMStructureLayout> orderByComparator)
Returns a range of d d m structure layouts matching the UUID and company.

Parameters:
uuid - the UUID of the d d m structure layouts
companyId - the primary key of the company
start - the lower bound of the range of d d m structure layouts
end - the upper bound of the range of d d m structure layouts (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the range of matching d d m structure layouts, or an empty list if no matches were found

getDDMStructureLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDDMStructureLayoutsCount()
Returns the number of d d m structure layouts.

Returns:
the number of d d m structure layouts

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

getStructureLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructureLayout getStructureLayout(long structureLayoutId)
                                      throws PortalException
Throws:
PortalException

getStructureLayoutByStructureVersionId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDMStructureLayout getStructureLayoutByStructureVersionId(long structureVersionId)
                                                          throws PortalException
Throws:
PortalException

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

updateDDMStructureLayout

@Indexable(type=REINDEX)
DDMStructureLayout updateDDMStructureLayout(DDMStructureLayout ddmStructureLayout)
Updates the d d m structure layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
ddmStructureLayout - the d d m structure layout
Returns:
the d d m structure layout that was updated

updateStructureLayout

DDMStructureLayout updateStructureLayout(long structureLayoutId,
                                         DDMFormLayout ddmFormLayout,
                                         ServiceContext serviceContext)
                                         throws PortalException
Throws:
PortalException

Liferay 7.0-ce-m6