|
Liferay 6.2.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType public interface PortletPersistence
The persistence interface for the portlet service.
Caching information and settings can be found in portal.properties
PortletPersistenceImpl,
PortletUtil| Method Summary | |
|---|---|
abstract void |
cacheResult(List<Portlet> portlets)
Caches the portlets in the entity cache if it is enabled. |
abstract void |
cacheResult(Portlet portlet)
Caches the portlet in the entity cache if it is enabled. |
abstract int |
countAll()
Returns the number of portlets. |
abstract int |
countByC_P(long companyId,
String portletId)
Returns the number of portlets where companyId = ? and portletId = ?. |
abstract int |
countByCompanyId(long companyId)
Returns the number of portlets where companyId = ?. |
abstract Portlet |
create(long id)
Creates a new portlet with the primary key. |
abstract Portlet |
fetchByC_P(long companyId,
String portletId)
Returns the portlet where companyId = ? and portletId = ? or returns null if it could not be found. |
abstract 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. |
abstract Portlet |
fetchByCompanyId_First(long companyId,
OrderByComparator orderByComparator)
Returns the first portlet in the ordered set where companyId = ?. |
abstract Portlet |
fetchByCompanyId_Last(long companyId,
OrderByComparator orderByComparator)
Returns the last portlet in the ordered set where companyId = ?. |
abstract Portlet |
fetchByPrimaryKey(long id)
Returns the portlet with the primary key or returns null if it could not be found. |
abstract List<Portlet> |
findAll()
Returns all the portlets. |
abstract List<Portlet> |
findAll(int start,
int end)
Returns a range of all the portlets. |
abstract List<Portlet> |
findAll(int start,
int end,
OrderByComparator orderByComparator)
Returns an ordered range of all the portlets. |
abstract Portlet |
findByC_P(long companyId,
String portletId)
Returns the portlet where companyId = ? and portletId = ? or throws a NoSuchPortletException if it could not be found. |
abstract Portlet |
findByCompanyId_First(long companyId,
OrderByComparator orderByComparator)
Returns the first portlet in the ordered set where companyId = ?. |
abstract Portlet |
findByCompanyId_Last(long companyId,
OrderByComparator orderByComparator)
Returns the last portlet in the ordered set where companyId = ?. |
abstract Portlet[] |
findByCompanyId_PrevAndNext(long id,
long companyId,
OrderByComparator orderByComparator)
Returns the portlets before and after the current portlet in the ordered set where companyId = ?. |
abstract List<Portlet> |
findByCompanyId(long companyId)
Returns all the portlets where companyId = ?. |
abstract List<Portlet> |
findByCompanyId(long companyId,
int start,
int end)
Returns a range of all the portlets where companyId = ?. |
abstract List<Portlet> |
findByCompanyId(long companyId,
int start,
int end,
OrderByComparator orderByComparator)
Returns an ordered range of all the portlets where companyId = ?. |
abstract Portlet |
findByPrimaryKey(long id)
Returns the portlet with the primary key or throws a NoSuchPortletException if it could not be found. |
abstract Portlet |
remove(long id)
Removes the portlet with the primary key from the database. |
abstract void |
removeAll()
Removes all the portlets from the database. |
abstract Portlet |
removeByC_P(long companyId,
String portletId)
Removes the portlet where companyId = ? and portletId = ? from the database. |
abstract void |
removeByCompanyId(long companyId)
Removes all the portlets where companyId = ? from the database. |
abstract Portlet |
updateImpl(Portlet portlet)
|
| Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence |
|---|
clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, flush, getCurrentSession, getDataSource, getListeners, getModelClass, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update, update, update |
| Method Detail |
|---|
List<Portlet> findByCompanyId(long companyId)
throws SystemException
companyId - the company ID
SystemException - if a system exception occurred
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 occurred
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 occurred
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 occurred
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 occurred
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 occurred
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 occurred
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 occurred
void removeByCompanyId(long companyId)
throws SystemException
companyId - the company ID
SystemException - if a system exception occurred
int countByCompanyId(long companyId)
throws SystemException
companyId - the company ID
SystemException - if a system exception occurred
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 occurred
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 occurred
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 occurred
Portlet removeByC_P(long companyId,
String portletId)
throws NoSuchPortletException,
SystemException
companyId - the company IDportletId - the portlet ID
SystemException - if a system exception occurred
NoSuchPortletException
int countByC_P(long companyId,
String portletId)
throws SystemException
companyId - the company IDportletId - the portlet ID
SystemException - if a system exception occurredvoid cacheResult(Portlet portlet)
portlet - the portletvoid cacheResult(List<Portlet> portlets)
portlets - the portletsPortlet create(long id)
id - the primary key for the new portlet
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 occurred
Portlet updateImpl(Portlet portlet)
throws SystemException
SystemException
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 occurred
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 occurred
List<Portlet> findAll()
throws SystemException
SystemException - if a system exception occurred
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 occurred
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 occurred
void removeAll()
throws SystemException
SystemException - if a system exception occurred
int countAll()
throws SystemException
SystemException - if a system exception occurred
|
Liferay 6.2.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||