com.liferay.portal.service
Class LayoutSetPrototypeLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.LayoutSetPrototypeLocalServiceUtil

@ProviderType
public class LayoutSetPrototypeLocalServiceUtil
extends Object

Provides the local service utility for LayoutSetPrototype. This utility wraps com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl 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:

LayoutSetPrototypeLocalService, LayoutSetPrototypeLocalServiceBaseImpl, com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl

Constructor Summary

LayoutSetPrototypeLocalServiceUtil()

Method Summary

static LayoutSetPrototype	addLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) Adds the layout set prototype to the database.
static LayoutSetPrototype	addLayoutSetPrototype(long userId, long companyId, Map<Locale,String> nameMap, String description, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext)
static LayoutSetPrototype	createLayoutSetPrototype(long layoutSetPrototypeId) Creates a new layout set prototype with the primary key.
static LayoutSetPrototype	deleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) Deletes the layout set prototype from the database.
static LayoutSetPrototype	deleteLayoutSetPrototype(long layoutSetPrototypeId) Deletes the layout set prototype with the primary key from the database.
static void	deleteLayoutSetPrototypes()
static void	deleteNondefaultLayoutSetPrototypes(long companyId)
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static LayoutSetPrototype	fetchLayoutSetPrototype(long layoutSetPrototypeId)
static LayoutSetPrototype	fetchLayoutSetPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout set prototype with the matching UUID and company.
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static LayoutSetPrototype	getLayoutSetPrototype(long layoutSetPrototypeId) Returns the layout set prototype with the primary key.
static LayoutSetPrototype	getLayoutSetPrototypeByUuid(String uuid) Deprecated. As of 6.2.0, replaced by getLayoutSetPrototypeByUuidAndCompanyId(String, long)
static LayoutSetPrototype	getLayoutSetPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout set prototype with the matching UUID and company.
static List<LayoutSetPrototype>	getLayoutSetPrototypes(int start, int end) Returns a range of all the layout set prototypes.
static List<LayoutSetPrototype>	getLayoutSetPrototypes(long companyId)
static int	getLayoutSetPrototypesCount() Returns the number of layout set prototypes.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static LayoutSetPrototypeLocalService	getService()
static List<LayoutSetPrototype>	search(long companyId, Boolean active, int start, int end, OrderByComparator obc)
static int	searchCount(long companyId, Boolean active)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(LayoutSetPrototypeLocalService service) Deprecated. As of 6.2.0
static LayoutSetPrototype	updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) Updates the layout set prototype in the database or adds it if it does not yet exist.
static LayoutSetPrototype	updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale,String> nameMap, String description, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext)
static LayoutSetPrototype	updateLayoutSetPrototype(long layoutSetPrototypeId, String settings)

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutSetPrototypeLocalServiceUtil

public LayoutSetPrototypeLocalServiceUtil()

Method Detail

addLayoutSetPrototype

public static LayoutSetPrototype addLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
                                                throws SystemException

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

Parameters:

layoutSetPrototype - the layout set prototype

Returns:

the layout set prototype that was added

Throws:

SystemException - if a system exception occurred

createLayoutSetPrototype

public static LayoutSetPrototype createLayoutSetPrototype(long layoutSetPrototypeId)

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

Parameters:

layoutSetPrototypeId - the primary key for the new layout set prototype

Returns:

the new layout set prototype

deleteLayoutSetPrototype

public static LayoutSetPrototype deleteLayoutSetPrototype(long layoutSetPrototypeId)
                                                   throws PortalException,
                                                          SystemException

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

Parameters:

layoutSetPrototypeId - the primary key of the layout set prototype

Returns:

the layout set prototype that was removed

Throws:

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

SystemException - if a system exception occurred

deleteLayoutSetPrototype

public static LayoutSetPrototype deleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
                                                   throws PortalException,
                                                          SystemException

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

Parameters:

layoutSetPrototype - the layout set prototype

Returns:

the layout set prototype that was removed

Throws:

PortalException

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchLayoutSetPrototype

public static LayoutSetPrototype fetchLayoutSetPrototype(long layoutSetPrototypeId)
                                                  throws SystemException

Throws:

SystemException

fetchLayoutSetPrototypeByUuidAndCompanyId

public static LayoutSetPrototype fetchLayoutSetPrototypeByUuidAndCompanyId(String uuid,
                                                                           long companyId)
                                                                    throws SystemException

Returns the layout set prototype with the matching UUID and company.

Parameters:

uuid - the layout set prototype's UUID

companyId - the primary key of the company

Returns:

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

Throws:

SystemException - if a system exception occurred

getLayoutSetPrototype

public static LayoutSetPrototype getLayoutSetPrototype(long layoutSetPrototypeId)
                                                throws PortalException,
                                                       SystemException

Returns the layout set prototype with the primary key.

Parameters:

layoutSetPrototypeId - the primary key of the layout set prototype

Returns:

the layout set prototype

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getLayoutSetPrototypeByUuidAndCompanyId

public static LayoutSetPrototype getLayoutSetPrototypeByUuidAndCompanyId(String uuid,
                                                                         long companyId)
                                                                  throws PortalException,
                                                                         SystemException

Returns the layout set prototype with the matching UUID and company.

Parameters:

uuid - the layout set prototype's UUID

companyId - the primary key of the company

Returns:

the matching layout set prototype

Throws:

PortalException - if a matching layout set prototype could not be found

SystemException - if a system exception occurred

getLayoutSetPrototypes

public static List<LayoutSetPrototype> getLayoutSetPrototypes(int start,
                                                              int end)
                                                       throws SystemException

Returns a range of all the layout set 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 LayoutSetPrototypeModelImpl. 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 set prototypes

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

Returns:

the range of layout set prototypes

Throws:

SystemException - if a system exception occurred

getLayoutSetPrototypesCount

public static int getLayoutSetPrototypesCount()
                                       throws SystemException

Returns the number of layout set prototypes.

Returns:

the number of layout set prototypes

Throws:

SystemException - if a system exception occurred

updateLayoutSetPrototype

public static LayoutSetPrototype updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
                                                   throws SystemException

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

Parameters:

layoutSetPrototype - the layout set prototype

Returns:

the layout set prototype that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addLayoutSetPrototype

public static LayoutSetPrototype addLayoutSetPrototype(long userId,
                                                       long companyId,
                                                       Map<Locale,String> nameMap,
                                                       String description,
                                                       boolean active,
                                                       boolean layoutsUpdateable,
                                                       ServiceContext serviceContext)
                                                throws PortalException,
                                                       SystemException

Throws:

PortalException

SystemException

deleteLayoutSetPrototypes

public static void deleteLayoutSetPrototypes()
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

deleteNondefaultLayoutSetPrototypes

public static void deleteNondefaultLayoutSetPrototypes(long companyId)
                                                throws PortalException,
                                                       SystemException

Throws:

PortalException

SystemException

getLayoutSetPrototypeByUuid

public static LayoutSetPrototype getLayoutSetPrototypeByUuid(String uuid)
                                                      throws PortalException,
                                                             SystemException

Deprecated. As of 6.2.0, replaced by getLayoutSetPrototypeByUuidAndCompanyId(String, long)

Throws:

PortalException

SystemException

getLayoutSetPrototypes

public static List<LayoutSetPrototype> getLayoutSetPrototypes(long companyId)
                                                       throws SystemException

Throws:

SystemException

search

public static List<LayoutSetPrototype> search(long companyId,
                                              Boolean active,
                                              int start,
                                              int end,
                                              OrderByComparator obc)
                                       throws SystemException

Throws:

SystemException

searchCount

public static int searchCount(long companyId,
                              Boolean active)
                       throws SystemException

Throws:

SystemException

updateLayoutSetPrototype

public static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId,
                                                          Map<Locale,String> nameMap,
                                                          String description,
                                                          boolean active,
                                                          boolean layoutsUpdateable,
                                                          ServiceContext serviceContext)
                                                   throws PortalException,
                                                          SystemException

Throws:

PortalException

SystemException

updateLayoutSetPrototype

public static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId,
                                                          String settings)
                                                   throws PortalException,
                                                          SystemException

Throws:

PortalException

SystemException

getService

public static LayoutSetPrototypeLocalService getService()

setService

public void setService(LayoutSetPrototypeLocalService service)

Deprecated. As of 6.2.0