com.liferay.portal.kernel.service

Class LayoutPrototypeLocalServiceUtil

java.lang.Object

com.liferay.portal.kernel.service.LayoutPrototypeLocalServiceUtil

@ProviderType
public class LayoutPrototypeLocalServiceUtil
extends java.lang.Object

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

Author:

Brian Wing Shun Chan

See Also:

LayoutPrototypeLocalService, LayoutPrototypeLocalServiceBaseImpl, LayoutPrototypeLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
LayoutPrototypeLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static LayoutPrototype	addLayoutPrototype(LayoutPrototype layoutPrototype) Adds the layout prototype to the database.
static LayoutPrototype	addLayoutPrototype(long userId, long companyId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, boolean active, ServiceContext serviceContext)
static LayoutPrototype	addLayoutPrototype(long userId, long companyId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.lang.String description, boolean active, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by addLayoutPrototype(long, long, Map, Map, boolean, ServiceContext)
static LayoutPrototype	createLayoutPrototype(long layoutPrototypeId) Creates a new layout prototype with the primary key.
static LayoutPrototype	deleteLayoutPrototype(LayoutPrototype layoutPrototype) Deletes the layout prototype from the database.
static LayoutPrototype	deleteLayoutPrototype(long layoutPrototypeId) Deletes the layout prototype with the primary key from the database.
static void	deleteNondefaultLayoutPrototypes(long companyId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
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 LayoutPrototype	fetchLayoutPrototype(long layoutPrototypeId)
static LayoutPrototype	fetchLayoutPrototype(long companyId, java.lang.String name, java.util.Locale locale)
static LayoutPrototype	fetchLayoutPrototypeByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the layout prototype with the matching UUID and company.
static LayoutPrototype	fetchLayoutProtoype(long companyId, java.lang.String name)
static ActionableDynamicQuery	getActionableDynamicQuery()
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static LayoutPrototype	getLayoutPrototype(long layoutPrototypeId) Returns the layout prototype with the primary key.
static LayoutPrototype	getLayoutPrototype(long companyId, java.lang.String name)
static LayoutPrototype	getLayoutPrototype(long companyId, java.lang.String name, java.util.Locale locale)
static LayoutPrototype	getLayoutPrototypeByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the layout prototype with the matching UUID and company.
static java.util.List<LayoutPrototype>	getLayoutPrototypes(int start, int end) Returns a range of all the layout prototypes.
static int	getLayoutPrototypesCount() Returns the number of layout prototypes.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static LayoutPrototypeLocalService	getService()
static java.util.List<LayoutPrototype>	search(long companyId, java.lang.Boolean active, int start, int end, OrderByComparator<LayoutPrototype> obc)
static int	searchCount(long companyId, java.lang.Boolean active)
static LayoutPrototype	updateLayoutPrototype(LayoutPrototype layoutPrototype) Updates the layout prototype in the database or adds it if it does not yet exist.
static LayoutPrototype	updateLayoutPrototype(long layoutPrototypeId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, boolean active, ServiceContext serviceContext)
static LayoutPrototype	updateLayoutPrototype(long layoutPrototypeId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.lang.String description, boolean active, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by updateLayoutPrototype(long, Map, Map, boolean, ServiceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutPrototypeLocalServiceUtil

public LayoutPrototypeLocalServiceUtil()

Method Detail

addLayoutPrototype

public static LayoutPrototype addLayoutPrototype(LayoutPrototype layoutPrototype)

Adds the layout prototype to the database. Also notifies the appropriate model listeners.

Parameters:

layoutPrototype - the layout prototype

Returns:

the layout prototype that was added

addLayoutPrototype

public static LayoutPrototype addLayoutPrototype(long userId,
                                                 long companyId,
                                                 java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                 java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                 boolean active,
                                                 ServiceContext serviceContext)
                                          throws PortalException

Throws:

PortalException

addLayoutPrototype

@Deprecated
public static LayoutPrototype addLayoutPrototype(long userId,
                                                             long companyId,
                                                             java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                             java.lang.String description,
                                                             boolean active,
                                                             ServiceContext serviceContext)
                                                      throws PortalException

Deprecated. As of 7.0.0, replaced by addLayoutPrototype(long, long, Map, Map, boolean, ServiceContext)

Throws:

PortalException

createLayoutPrototype

public static LayoutPrototype createLayoutPrototype(long layoutPrototypeId)

Creates a new layout prototype with the primary key. Does not add the layout prototype to the database.

Parameters:

layoutPrototypeId - the primary key for the new layout prototype

Returns:

the new layout prototype

deleteLayoutPrototype

public static LayoutPrototype deleteLayoutPrototype(LayoutPrototype layoutPrototype)
                                             throws PortalException

Deletes the layout prototype from the database. Also notifies the appropriate model listeners.

Parameters:

layoutPrototype - the layout prototype

Returns:

the layout prototype that was removed

Throws:

PortalException

deleteLayoutPrototype

public static LayoutPrototype deleteLayoutPrototype(long layoutPrototypeId)
                                             throws PortalException

Deletes the layout prototype with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

layoutPrototypeId - the primary key of the layout prototype

Returns:

the layout prototype that was removed

Throws:

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

deleteNondefaultLayoutPrototypes

public static void deleteNondefaultLayoutPrototypes(long companyId)
                                             throws PortalException

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

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

fetchLayoutPrototype

public static LayoutPrototype fetchLayoutPrototype(long layoutPrototypeId)

fetchLayoutPrototype

public static LayoutPrototype fetchLayoutPrototype(long companyId,
                                                   java.lang.String name,
                                                   java.util.Locale locale)

fetchLayoutPrototypeByUuidAndCompanyId

public static LayoutPrototype fetchLayoutPrototypeByUuidAndCompanyId(java.lang.String uuid,
                                                                     long companyId)

Returns the layout prototype with the matching UUID and company.

Parameters:

uuid - the layout prototype's UUID

companyId - the primary key of the company

Returns:

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

fetchLayoutProtoype

public static LayoutPrototype fetchLayoutProtoype(long companyId,
                                                  java.lang.String name)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayoutPrototype

public static LayoutPrototype getLayoutPrototype(long layoutPrototypeId)
                                          throws PortalException

Returns the layout prototype with the primary key.

Parameters:

layoutPrototypeId - the primary key of the layout prototype

Returns:

the layout prototype

Throws:

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

getLayoutPrototype

public static LayoutPrototype getLayoutPrototype(long companyId,
                                                 java.lang.String name)
                                          throws PortalException

Throws:

PortalException

getLayoutPrototype

public static LayoutPrototype getLayoutPrototype(long companyId,
                                                 java.lang.String name,
                                                 java.util.Locale locale)
                                          throws PortalException

Throws:

PortalException

getLayoutPrototypeByUuidAndCompanyId

public static LayoutPrototype getLayoutPrototypeByUuidAndCompanyId(java.lang.String uuid,
                                                                   long companyId)
                                                            throws PortalException

Returns the layout prototype with the matching UUID and company.

Parameters:

uuid - the layout prototype's UUID

companyId - the primary key of the company

Returns:

the matching layout prototype

Throws:

PortalException - if a matching layout prototype could not be found

getLayoutPrototypes

public static java.util.List<LayoutPrototype> getLayoutPrototypes(int start,
                                                                  int end)

Returns a range of all the layout prototypes.

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 LayoutPrototypeModelImpl. 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 layout prototypes

end - the upper bound of the range of layout prototypes (not inclusive)

Returns:

the range of layout prototypes

getLayoutPrototypesCount

public static int getLayoutPrototypesCount()

Returns the number of layout prototypes.

Returns:

the number of layout prototypes

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

search

public static java.util.List<LayoutPrototype> search(long companyId,
                                                     java.lang.Boolean active,
                                                     int start,
                                                     int end,
                                                     OrderByComparator<LayoutPrototype> obc)

searchCount

public static int searchCount(long companyId,
                              java.lang.Boolean active)

updateLayoutPrototype

public static LayoutPrototype updateLayoutPrototype(LayoutPrototype layoutPrototype)

Updates the layout prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

layoutPrototype - the layout prototype

Returns:

the layout prototype that was updated

updateLayoutPrototype

public static LayoutPrototype updateLayoutPrototype(long layoutPrototypeId,
                                                    java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                    java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                    boolean active,
                                                    ServiceContext serviceContext)
                                             throws PortalException

Throws:

PortalException

updateLayoutPrototype

@Deprecated
public static LayoutPrototype updateLayoutPrototype(long layoutPrototypeId,
                                                                java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                                java.lang.String description,
                                                                boolean active,
                                                                ServiceContext serviceContext)
                                                         throws PortalException

Deprecated. As of 7.0.0, replaced by updateLayoutPrototype(long, Map, Map, boolean, ServiceContext)

Throws:

PortalException

getService

public static LayoutPrototypeLocalService getService()