com.liferay.portal.service
Class LayoutPrototypeLocalServiceUtil

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

public class LayoutPrototypeLocalServiceUtil
extends Object

The utility for the layout prototype local service. This utility wraps LayoutPrototypeLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. 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:

LayoutPrototypeLocalService, LayoutPrototypeLocalServiceBaseImpl, LayoutPrototypeLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

LayoutPrototypeLocalServiceUtil()

Method Summary

static LayoutPrototype	addLayoutPrototype(LayoutPrototype layoutPrototype) Adds the layout prototype to the database.
static LayoutPrototype	addLayoutPrototype(long userId, long companyId, Map<Locale,String> nameMap, String description, boolean active)
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 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 LayoutPrototype	fetchLayoutPrototype(long layoutPrototypeId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static LayoutPrototype	getLayoutPrototype(long layoutPrototypeId) Returns the layout prototype with the primary key.
static LayoutPrototype	getLayoutPrototypeByUuid(String uuid)
static 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 PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static LayoutPrototypeLocalService	getService()
static List<LayoutPrototype>	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(LayoutPrototypeLocalService service) Deprecated.
static LayoutPrototype	updateLayoutPrototype(LayoutPrototype layoutPrototype) Updates the layout prototype in the database or adds it if it does not yet exist.
static LayoutPrototype	updateLayoutPrototype(LayoutPrototype layoutPrototype, boolean merge) Updates the layout prototype in the database or adds it if it does not yet exist.
static LayoutPrototype	updateLayoutPrototype(long layoutPrototypeId, Map<Locale,String> nameMap, String description, boolean active)

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)
                                          throws SystemException

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

Throws:

SystemException - if a system exception occurred

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(long layoutPrototypeId)
                                             throws PortalException,
                                                    SystemException

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

SystemException - if a system exception occurred

deleteLayoutPrototype

public static LayoutPrototype deleteLayoutPrototype(LayoutPrototype layoutPrototype)
                                             throws PortalException,
                                                    SystemException

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

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.

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.

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

fetchLayoutPrototype

public static LayoutPrototype fetchLayoutPrototype(long layoutPrototypeId)
                                            throws SystemException

Throws:

SystemException

getLayoutPrototype

public static LayoutPrototype getLayoutPrototype(long layoutPrototypeId)
                                          throws PortalException,
                                                 SystemException

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

SystemException - if a system exception occurred

getPersistedModel

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

Throws:

PortalException

SystemException

getLayoutPrototypes

public static List<LayoutPrototype> getLayoutPrototypes(int start,
                                                        int end)
                                                 throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

getLayoutPrototypesCount

public static int getLayoutPrototypesCount()
                                    throws SystemException

Returns the number of layout prototypes.

Returns:

the number of layout prototypes

Throws:

SystemException - if a system exception occurred

updateLayoutPrototype

public static LayoutPrototype updateLayoutPrototype(LayoutPrototype layoutPrototype)
                                             throws SystemException

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

Throws:

SystemException - if a system exception occurred

updateLayoutPrototype

public static LayoutPrototype updateLayoutPrototype(LayoutPrototype layoutPrototype,
                                                    boolean merge)
                                             throws SystemException

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

merge - whether to merge the layout prototype with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the layout 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

addLayoutPrototype

public static LayoutPrototype addLayoutPrototype(long userId,
                                                 long companyId,
                                                 Map<Locale,String> nameMap,
                                                 String description,
                                                 boolean active)
                                          throws PortalException,
                                                 SystemException

Throws:

PortalException

SystemException

getLayoutPrototypeByUuid

public static LayoutPrototype getLayoutPrototypeByUuid(String uuid)
                                                throws PortalException,
                                                       SystemException

Throws:

PortalException

SystemException

search

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

updateLayoutPrototype

public static LayoutPrototype updateLayoutPrototype(long layoutPrototypeId,
                                                    Map<Locale,String> nameMap,
                                                    String description,
                                                    boolean active)
                                             throws PortalException,
                                                    SystemException

Throws:

PortalException

SystemException

getService

public static LayoutPrototypeLocalService getService()

setService

public void setService(LayoutPrototypeLocalService service)

Deprecated.