|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.persistence.PortletUtil
@ProviderType public class PortletUtil
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
PortletPersistence
,
PortletPersistenceImpl
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 |
---|
public PortletUtil()
Method Detail |
---|
public static void clearCache()
BasePersistence.clearCache()
public static void clearCache(Portlet portlet)
BasePersistence.clearCache(com.liferay.portal.model.BaseModel)
public static long countWithDynamicQuery(DynamicQuery dynamicQuery) throws SystemException
SystemException
BasePersistence.countWithDynamicQuery(DynamicQuery)
public static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery) throws SystemException
SystemException
BasePersistence.findWithDynamicQuery(DynamicQuery)
public static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
SystemException
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)
public static List<Portlet> findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)
public static Portlet update(Portlet portlet) throws SystemException
SystemException
BasePersistence.update(com.liferay.portal.model.BaseModel)
public static Portlet update(Portlet portlet, ServiceContext serviceContext) throws SystemException
SystemException
BasePersistence.update(com.liferay.portal.model.BaseModel, ServiceContext)
public static List<Portlet> findByCompanyId(long companyId) throws SystemException
companyId
- the company ID
SystemException
- if a system exception occurredpublic static List<Portlet> findByCompanyId(long companyId, int start, int end) throws SystemException
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.
companyId
- the company IDstart
- the lower bound of the range of portletsend
- the upper bound of the range of portlets (not inclusive)
SystemException
- if a system exception occurredpublic static List<Portlet> findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
companyId
- the company IDstart
- the lower bound of the range of portletsend
- the upper bound of the range of portlets (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)
SystemException
- if a system exception occurredpublic static Portlet findByCompanyId_First(long companyId, OrderByComparator orderByComparator) throws NoSuchPortletException, SystemException
companyId
- the company IDorderByComparator
- the comparator to order the set by (optionally null
)
NoSuchPortletException
- if a matching portlet could not be found
SystemException
- if a system exception occurredpublic static Portlet fetchByCompanyId_First(long companyId, OrderByComparator orderByComparator) throws SystemException
companyId
- the company IDorderByComparator
- the comparator to order the set by (optionally null
)
null
if a matching portlet could not be found
SystemException
- if a system exception occurredpublic static Portlet findByCompanyId_Last(long companyId, OrderByComparator orderByComparator) throws NoSuchPortletException, SystemException
companyId
- the company IDorderByComparator
- the comparator to order the set by (optionally null
)
NoSuchPortletException
- if a matching portlet could not be found
SystemException
- if a system exception occurredpublic static Portlet fetchByCompanyId_Last(long companyId, OrderByComparator orderByComparator) throws SystemException
companyId
- the company IDorderByComparator
- the comparator to order the set by (optionally null
)
null
if a matching portlet could not be found
SystemException
- if a system exception occurredpublic static Portlet[] findByCompanyId_PrevAndNext(long id, long companyId, OrderByComparator orderByComparator) throws NoSuchPortletException, SystemException
id
- the primary key of the current portletcompanyId
- the company IDorderByComparator
- the comparator to order the set by (optionally null
)
NoSuchPortletException
- if a portlet with the primary key could not be found
SystemException
- if a system exception occurredpublic static void removeByCompanyId(long companyId) throws SystemException
companyId
- the company ID
SystemException
- if a system exception occurredpublic static int countByCompanyId(long companyId) throws SystemException
companyId
- the company ID
SystemException
- if a system exception occurredpublic static Portlet findByC_P(long companyId, String portletId) throws NoSuchPortletException, SystemException
NoSuchPortletException
if it could not be found.
companyId
- the company IDportletId
- the portlet ID
NoSuchPortletException
- if a matching portlet could not be found
SystemException
- if a system exception occurredpublic static Portlet fetchByC_P(long companyId, String portletId) throws SystemException
null
if it could not be found. Uses the finder cache.
companyId
- the company IDportletId
- the portlet ID
null
if a matching portlet could not be found
SystemException
- if a system exception occurredpublic static Portlet fetchByC_P(long companyId, String portletId, boolean retrieveFromCache) throws SystemException
null
if it could not be found, optionally using the finder cache.
companyId
- the company IDportletId
- the portlet IDretrieveFromCache
- whether to use the finder cache
null
if a matching portlet could not be found
SystemException
- if a system exception occurredpublic static Portlet removeByC_P(long companyId, String portletId) throws NoSuchPortletException, SystemException
companyId
- the company IDportletId
- the portlet ID
SystemException
- if a system exception occurred
NoSuchPortletException
public static int countByC_P(long companyId, String portletId) throws SystemException
companyId
- the company IDportletId
- the portlet ID
SystemException
- if a system exception occurredpublic static void cacheResult(Portlet portlet)
portlet
- the portletpublic static void cacheResult(List<Portlet> portlets)
portlets
- the portletspublic static Portlet create(long id)
id
- the primary key for the new portlet
public static Portlet remove(long id) throws NoSuchPortletException, SystemException
id
- the primary key of the portlet
NoSuchPortletException
- if a portlet with the primary key could not be found
SystemException
- if a system exception occurredpublic static Portlet updateImpl(Portlet portlet) throws SystemException
SystemException
public static Portlet findByPrimaryKey(long id) throws NoSuchPortletException, SystemException
NoSuchPortletException
if it could not be found.
id
- the primary key of the portlet
NoSuchPortletException
- if a portlet with the primary key could not be found
SystemException
- if a system exception occurredpublic static Portlet fetchByPrimaryKey(long id) throws SystemException
null
if it could not be found.
id
- the primary key of the portlet
null
if a portlet with the primary key could not be found
SystemException
- if a system exception occurredpublic static List<Portlet> findAll() throws SystemException
SystemException
- if a system exception occurredpublic static List<Portlet> findAll(int start, int end) throws SystemException
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.
start
- the lower bound of the range of portletsend
- the upper bound of the range of portlets (not inclusive)
SystemException
- if a system exception occurredpublic static List<Portlet> findAll(int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
start
- the lower bound of the range of portletsend
- the upper bound of the range of portlets (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)
SystemException
- if a system exception occurredpublic static void removeAll() throws SystemException
SystemException
- if a system exception occurredpublic static int countAll() throws SystemException
SystemException
- if a system exception occurredpublic static PortletPersistence getPersistence()
public void setPersistence(PortletPersistence persistence)
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |