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