Liferay 6.2-ce-ga5

com.liferay.portal.service.persistence
Class PortletUtil

java.lang.Object
  extended by com.liferay.portal.service.persistence.PortletUtil

@ProviderType
public class PortletUtil
extends Object

The persistence utility for the portlet service. This utility wraps PortletPersistenceImpl and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.

Caching information and settings can be found in portal.properties

See Also:
PortletPersistence, PortletPersistenceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
PortletUtil()
           
 
Method Summary
static void cacheResult(List<Portlet> portlets)
          Caches the portlets in the entity cache if it is enabled.
static void cacheResult(Portlet portlet)
          Caches the portlet in the entity cache if it is enabled.
static void clearCache()
           
static void clearCache(Portlet portlet)
           
static int countAll()
          Returns the number of portlets.
static int countByC_P(long companyId, String portletId)
          Returns the number of portlets where companyId = ? and portletId = ?.
static int countByCompanyId(long companyId)
          Returns the number of portlets where companyId = ?.
static long countWithDynamicQuery(DynamicQuery dynamicQuery)
           
static Portlet create(long id)
          Creates a new portlet with the primary key.
static Portlet fetchByC_P(long companyId, String portletId)
          Returns the portlet where companyId = ? and portletId = ? or returns null if it could not be found.
static Portlet fetchByC_P(long companyId, String portletId, boolean retrieveFromCache)
          Returns the portlet where companyId = ? and portletId = ? or returns null if it could not be found, optionally using the finder cache.
static Portlet fetchByCompanyId_First(long companyId, OrderByComparator orderByComparator)
          Returns the first portlet in the ordered set where companyId = ?.
static Portlet fetchByCompanyId_Last(long companyId, OrderByComparator orderByComparator)
          Returns the last portlet in the ordered set where companyId = ?.
static Portlet fetchByPrimaryKey(long id)
          Returns the portlet with the primary key or returns null if it could not be found.
static List<Portlet> findAll()
          Returns all the portlets.
static List<Portlet> findAll(int start, int end)
          Returns a range of all the portlets.
static List<Portlet> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the portlets.
static Portlet findByC_P(long companyId, String portletId)
          Returns the portlet where companyId = ? and portletId = ? or throws a NoSuchPortletException if it could not be found.
static Portlet findByCompanyId_First(long companyId, OrderByComparator orderByComparator)
          Returns the first portlet in the ordered set where companyId = ?.
static Portlet findByCompanyId_Last(long companyId, OrderByComparator orderByComparator)
          Returns the last portlet in the ordered set where companyId = ?.
static Portlet[] findByCompanyId_PrevAndNext(long id, long companyId, OrderByComparator orderByComparator)
          Returns the portlets before and after the current portlet in the ordered set where companyId = ?.
static List<Portlet> findByCompanyId(long companyId)
          Returns all the portlets where companyId = ?.
static List<Portlet> findByCompanyId(long companyId, int start, int end)
          Returns a range of all the portlets where companyId = ?.
static List<Portlet> findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the portlets where companyId = ?.
static Portlet findByPrimaryKey(long id)
          Returns the portlet with the primary key or throws a NoSuchPortletException if it could not be found.
static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery)
           
static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
           
static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
           
static PortletPersistence getPersistence()
           
static Portlet remove(long id)
          Removes the portlet with the primary key from the database.
static void removeAll()
          Removes all the portlets from the database.
static Portlet removeByC_P(long companyId, String portletId)
          Removes the portlet where companyId = ? and portletId = ? from the database.
static void removeByCompanyId(long companyId)
          Removes all the portlets where companyId = ? from the database.
 void setPersistence(PortletPersistence persistence)
          Deprecated. As of 6.2.0
static Portlet update(Portlet portlet)
           
static Portlet update(Portlet portlet, ServiceContext serviceContext)
           
static Portlet updateImpl(Portlet portlet)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortletUtil

public PortletUtil()
Method Detail

clearCache

public static void clearCache()
See Also:
BasePersistence.clearCache()

clearCache

public static void clearCache(Portlet portlet)
See Also:
BasePersistence.clearCache(com.liferay.portal.model.BaseModel)

countWithDynamicQuery

public static long countWithDynamicQuery(DynamicQuery dynamicQuery)
                                  throws SystemException
Throws:
SystemException
See Also:
BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery)
                                          throws SystemException
Throws:
SystemException
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)
                                          throws SystemException
Throws:
SystemException
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator orderByComparator)
                                          throws SystemException
Throws:
SystemException
See Also:
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static Portlet update(Portlet portlet)
                      throws SystemException
Throws:
SystemException
See Also:
BasePersistence.update(com.liferay.portal.model.BaseModel)

update

public static Portlet update(Portlet portlet,
                             ServiceContext serviceContext)
                      throws SystemException
Throws:
SystemException
See Also:
BasePersistence.update(com.liferay.portal.model.BaseModel, ServiceContext)

findByCompanyId

public static List<Portlet> findByCompanyId(long companyId)
                                     throws SystemException
Returns all the portlets where companyId = ?.

Parameters:
companyId - the company ID
Returns:
the matching portlets
Throws:
SystemException - if a system exception occurred

findByCompanyId

public static List<Portlet> findByCompanyId(long companyId,
                                            int start,
                                            int end)
                                     throws SystemException
Returns a range of all the portlets where companyId = ?.

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 PortletModelImpl. 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:
companyId - the company ID
start - the lower bound of the range of portlets
end - the upper bound of the range of portlets (not inclusive)
Returns:
the range of matching portlets
Throws:
SystemException - if a system exception occurred

findByCompanyId

public static List<Portlet> findByCompanyId(long companyId,
                                            int start,
                                            int end,
                                            OrderByComparator orderByComparator)
                                     throws SystemException
Returns an ordered range of all the portlets where companyId = ?.

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 PortletModelImpl. 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:
companyId - the company ID
start - the lower bound of the range of portlets
end - the upper bound of the range of portlets (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching portlets
Throws:
SystemException - if a system exception occurred

findByCompanyId_First

public static Portlet findByCompanyId_First(long companyId,
                                            OrderByComparator orderByComparator)
                                     throws NoSuchPortletException,
                                            SystemException
Returns the first portlet in the ordered set where companyId = ?.

Parameters:
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching portlet
Throws:
NoSuchPortletException - if a matching portlet could not be found
SystemException - if a system exception occurred

fetchByCompanyId_First

public static Portlet fetchByCompanyId_First(long companyId,
                                             OrderByComparator orderByComparator)
                                      throws SystemException
Returns the first portlet in the ordered set where companyId = ?.

Parameters:
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching portlet, or null if a matching portlet could not be found
Throws:
SystemException - if a system exception occurred

findByCompanyId_Last

public static Portlet findByCompanyId_Last(long companyId,
                                           OrderByComparator orderByComparator)
                                    throws NoSuchPortletException,
                                           SystemException
Returns the last portlet in the ordered set where companyId = ?.

Parameters:
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching portlet
Throws:
NoSuchPortletException - if a matching portlet could not be found
SystemException - if a system exception occurred

fetchByCompanyId_Last

public static Portlet fetchByCompanyId_Last(long companyId,
                                            OrderByComparator orderByComparator)
                                     throws SystemException
Returns the last portlet in the ordered set where companyId = ?.

Parameters:
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching portlet, or null if a matching portlet could not be found
Throws:
SystemException - if a system exception occurred

findByCompanyId_PrevAndNext

public static Portlet[] findByCompanyId_PrevAndNext(long id,
                                                    long companyId,
                                                    OrderByComparator orderByComparator)
                                             throws NoSuchPortletException,
                                                    SystemException
Returns the portlets before and after the current portlet in the ordered set where companyId = ?.

Parameters:
id - the primary key of the current portlet
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the previous, current, and next portlet
Throws:
NoSuchPortletException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred

removeByCompanyId

public static void removeByCompanyId(long companyId)
                              throws SystemException
Removes all the portlets where companyId = ? from the database.

Parameters:
companyId - the company ID
Throws:
SystemException - if a system exception occurred

countByCompanyId

public static int countByCompanyId(long companyId)
                            throws SystemException
Returns the number of portlets where companyId = ?.

Parameters:
companyId - the company ID
Returns:
the number of matching portlets
Throws:
SystemException - if a system exception occurred

findByC_P

public static Portlet findByC_P(long companyId,
                                String portletId)
                         throws NoSuchPortletException,
                                SystemException
Returns the portlet where companyId = ? and portletId = ? or throws a NoSuchPortletException if it could not be found.

Parameters:
companyId - the company ID
portletId - the portlet ID
Returns:
the matching portlet
Throws:
NoSuchPortletException - if a matching portlet could not be found
SystemException - if a system exception occurred

fetchByC_P

public static Portlet fetchByC_P(long companyId,
                                 String portletId)
                          throws SystemException
Returns the portlet where companyId = ? and portletId = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company ID
portletId - the portlet ID
Returns:
the matching portlet, or null if a matching portlet could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_P

public static Portlet fetchByC_P(long companyId,
                                 String portletId,
                                 boolean retrieveFromCache)
                          throws SystemException
Returns the portlet where companyId = ? and portletId = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company ID
portletId - the portlet ID
retrieveFromCache - whether to use the finder cache
Returns:
the matching portlet, or null if a matching portlet could not be found
Throws:
SystemException - if a system exception occurred

removeByC_P

public static Portlet removeByC_P(long companyId,
                                  String portletId)
                           throws NoSuchPortletException,
                                  SystemException
Removes the portlet where companyId = ? and portletId = ? from the database.

Parameters:
companyId - the company ID
portletId - the portlet ID
Returns:
the portlet that was removed
Throws:
SystemException - if a system exception occurred
NoSuchPortletException

countByC_P

public static int countByC_P(long companyId,
                             String portletId)
                      throws SystemException
Returns the number of portlets where companyId = ? and portletId = ?.

Parameters:
companyId - the company ID
portletId - the portlet ID
Returns:
the number of matching portlets
Throws:
SystemException - if a system exception occurred

cacheResult

public static void cacheResult(Portlet portlet)
Caches the portlet in the entity cache if it is enabled.

Parameters:
portlet - the portlet

cacheResult

public static void cacheResult(List<Portlet> portlets)
Caches the portlets in the entity cache if it is enabled.

Parameters:
portlets - the portlets

create

public static Portlet create(long id)
Creates a new portlet with the primary key. Does not add the portlet to the database.

Parameters:
id - the primary key for the new portlet
Returns:
the new portlet

remove

public static Portlet remove(long id)
                      throws NoSuchPortletException,
                             SystemException
Removes the portlet with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
id - the primary key of the portlet
Returns:
the portlet that was removed
Throws:
NoSuchPortletException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

public static Portlet updateImpl(Portlet portlet)
                          throws SystemException
Throws:
SystemException

findByPrimaryKey

public static Portlet findByPrimaryKey(long id)
                                throws NoSuchPortletException,
                                       SystemException
Returns the portlet with the primary key or throws a NoSuchPortletException if it could not be found.

Parameters:
id - the primary key of the portlet
Returns:
the portlet
Throws:
NoSuchPortletException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

public static Portlet fetchByPrimaryKey(long id)
                                 throws SystemException
Returns the portlet with the primary key or returns null if it could not be found.

Parameters:
id - the primary key of the portlet
Returns:
the portlet, or null if a portlet with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findAll

public static List<Portlet> findAll()
                             throws SystemException
Returns all the portlets.

Returns:
the portlets
Throws:
SystemException - if a system exception occurred

findAll

public static List<Portlet> findAll(int start,
                                    int end)
                             throws SystemException
Returns a range of all the portlets.

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 PortletModelImpl. 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 portlets
end - the upper bound of the range of portlets (not inclusive)
Returns:
the range of portlets
Throws:
SystemException - if a system exception occurred

findAll

public static List<Portlet> findAll(int start,
                                    int end,
                                    OrderByComparator orderByComparator)
                             throws SystemException
Returns an ordered range of all the portlets.

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 PortletModelImpl. 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 portlets
end - the upper bound of the range of portlets (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of portlets
Throws:
SystemException - if a system exception occurred

removeAll

public static void removeAll()
                      throws SystemException
Removes all the portlets from the database.

Throws:
SystemException - if a system exception occurred

countAll

public static int countAll()
                    throws SystemException
Returns the number of portlets.

Returns:
the number of portlets
Throws:
SystemException - if a system exception occurred

getPersistence

public static PortletPersistence getPersistence()

setPersistence

public void setPersistence(PortletPersistence persistence)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5