Liferay 6.0.5

com.liferay.portal.service
Class LayoutPrototypeLocalServiceUtil

java.lang.Object
  extended by 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.

Never modify this class directly. Add custom service methods to LayoutPrototypeLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

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 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 void deleteLayoutPrototype(LayoutPrototype layoutPrototype)
          Deletes the layout prototype from the database.
static void deleteLayoutPrototype(long layoutPrototypeId)
          Deletes the layout prototype with the primary key from the database.
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)
          Counts the number of rows that match the dynamic query.
static LayoutPrototype getLayoutPrototype(long layoutPrototypeId)
          Gets the layout prototype with the primary key.
static List<LayoutPrototype> getLayoutPrototypes(int start, int end)
          Gets a range of all the layout prototypes.
static int getLayoutPrototypesCount()
          Gets the number of layout prototypes.
static LayoutPrototypeLocalService getService()
           
static List<LayoutPrototype> search(long companyId, Boolean active, int start, int end, OrderByComparator obc)
           
static int searchCount(long companyId, Boolean active)
           
 void setService(LayoutPrototypeLocalService service)
           
static LayoutPrototype updateLayoutPrototype(LayoutPrototype layoutPrototype)
          Updates the layout prototype in the database.
static LayoutPrototype updateLayoutPrototype(LayoutPrototype layoutPrototype, boolean merge)
          Updates the layout prototype in the database.
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 to add
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 void 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 to delete
Throws:
PortalException - if a layout prototype with the primary key could not be found
SystemException - if a system exception occurred

deleteLayoutPrototype

public static void deleteLayoutPrototype(LayoutPrototype layoutPrototype)
                                  throws SystemException
Deletes the layout prototype from the database. Also notifies the appropriate model listeners.

Parameters:
layoutPrototype - the layout prototype to delete
Throws:
SystemException - if a system exception occurred

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 to search with
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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getLayoutPrototype

public static LayoutPrototype getLayoutPrototype(long layoutPrototypeId)
                                          throws PortalException,
                                                 SystemException
Gets the layout prototype with the primary key.

Parameters:
layoutPrototypeId - the primary key of the layout prototype to get
Returns:
the layout prototype
Throws:
PortalException - if a layout prototype with the primary key could not be found
SystemException - if a system exception occurred

getLayoutPrototypes

public static List<LayoutPrototype> getLayoutPrototypes(int start,
                                                        int end)
                                                 throws SystemException
Gets 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 to return
end - the upper bound of the range of layout prototypes to return (not inclusive)
Returns:
the range of layout prototypes
Throws:
SystemException - if a system exception occurred

getLayoutPrototypesCount

public static int getLayoutPrototypesCount()
                                    throws SystemException
Gets 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. Also notifies the appropriate model listeners.

Parameters:
layoutPrototype - the layout prototype to update
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. Also notifies the appropriate model listeners.

Parameters:
layoutPrototype - the layout prototype to update
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

addLayoutPrototype

public static LayoutPrototype addLayoutPrototype(long userId,
                                                 long companyId,
                                                 Map<Locale,String> nameMap,
                                                 String description,
                                                 boolean active)
                                          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)

Liferay 6.0.5