Liferay 7.0-ce-m6

com.liferay.portlet.dynamicdatamapping.service
Class DDMStructureLayoutLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.dynamicdatamapping.service.DDMStructureLayoutLocalServiceUtil

@ProviderType
public class DDMStructureLayoutLocalServiceUtil
extends Object

Provides the local service utility for DDMStructureLayout. This utility wraps com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLayoutLocalServiceImpl and is the primary 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, com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureLayoutLocalServiceBaseImpl, com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLayoutLocalServiceImpl

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

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

createDDMStructureLayout

public static 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

public static 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

public static 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

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

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public static <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 com.liferay.portlet.dynamicdatamapping.model.impl.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

public static <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 com.liferay.portlet.dynamicdatamapping.model.impl.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

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

public static ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

getDDMStructureLayout

public static 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

public static 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

public static 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 com.liferay.portlet.dynamicdatamapping.model.impl.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

public static 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

public static 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

public static int getDDMStructureLayoutsCount()
Returns the number of d d m structure layouts.

Returns:
the number of d d m structure layouts

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

getStructureLayout

public static DDMStructureLayout getStructureLayout(long structureLayoutId)
                                             throws PortalException
Throws:
PortalException

getStructureLayoutByStructureVersionId

public static DDMStructureLayout getStructureLayoutByStructureVersionId(long structureVersionId)
                                                                 throws PortalException
Throws:
PortalException

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

updateDDMStructureLayout

public static 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

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

getService

public static DDMStructureLayoutLocalService getService()

setService

@Deprecated
public void setService(DDMStructureLayoutLocalService service)
Deprecated. As of 6.2.0


Liferay 7.0-ce-m6