|
Liferay 6.2.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.PortletLocalServiceWrapper
public class PortletLocalServiceWrapper
This class is a wrapper for PortletLocalService.
PortletLocalService| Constructor Summary | |
|---|---|
PortletLocalServiceWrapper(PortletLocalService portletLocalService)
|
|
| Method Summary | |
|---|---|
Portlet |
addPortlet(Portlet portlet)
Adds the portlet to the database. |
void |
addPortletCategory(long companyId,
String categoryName)
|
void |
checkPortlet(Portlet portlet)
|
void |
checkPortlets(long companyId)
|
void |
clearCache()
|
void |
clearCompanyPortletsPool()
|
Portlet |
clonePortlet(long companyId,
String portletId)
Deprecated. clonePortlet(String) |
Portlet |
clonePortlet(String portletId)
|
Portlet |
createPortlet(long id)
Creates a new portlet with the primary key. |
Portlet |
deletePortlet(long id)
Deletes the portlet with the primary key from the database. |
void |
deletePortlet(long companyId,
String portletId,
long plid)
|
Portlet |
deletePortlet(Portlet portlet)
Deletes the portlet from the database. |
void |
deletePortlets(long companyId,
String[] portletIds,
long plid)
|
Portlet |
deployRemotePortlet(Portlet portlet,
String categoryName)
|
Portlet |
deployRemotePortlet(Portlet portlet,
String[] categoryNames)
|
void |
destroyPortlet(Portlet portlet)
|
void |
destroyRemotePortlet(Portlet portlet)
|
DynamicQuery |
dynamicQuery()
|
List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
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. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
Portlet |
fetchPortlet(long id)
|
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
List<CustomAttributesDisplay> |
getCustomAttributesDisplays()
|
PortletCategory |
getEARDisplay(String xml)
|
List<Portlet> |
getFriendlyURLMapperPortlets()
|
List<FriendlyURLMapper> |
getFriendlyURLMappers()
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
Portlet |
getPortlet(long id)
Returns the portlet with the primary key. |
PortletApp |
getPortletApp(String servletContextName)
|
Portlet |
getPortletById(long companyId,
String portletId)
|
Portlet |
getPortletById(String portletId)
|
Portlet |
getPortletByStrutsPath(long companyId,
String strutsPath)
|
List<Portlet> |
getPortlets()
|
List<Portlet> |
getPortlets(int start,
int end)
Returns a range of all the portlets. |
List<Portlet> |
getPortlets(long companyId)
|
List<Portlet> |
getPortlets(long companyId,
boolean showSystem,
boolean showPortal)
|
int |
getPortletsCount()
Returns the number of portlets. |
List<Portlet> |
getScopablePortlets()
|
PortletCategory |
getWARDisplay(String servletContextName,
String xml)
|
PortletLocalService |
getWrappedPortletLocalService()
Deprecated. Renamed to getWrappedService() |
PortletLocalService |
getWrappedService()
|
boolean |
hasPortlet(long companyId,
String portletId)
|
void |
initEAR(javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
|
List<Portlet> |
initWAR(String servletContextName,
javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
|
Map<String,Portlet> |
loadGetPortletsPool(long companyId)
|
void |
removeCompanyPortletsPool(long companyId)
|
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setWrappedPortletLocalService(PortletLocalService portletLocalService)
Deprecated. Renamed to setWrappedService(com.liferay.portal.service.PortletLocalService) |
void |
setWrappedService(PortletLocalService portletLocalService)
|
Portlet |
updatePortlet(long companyId,
String portletId,
String roles,
boolean active)
|
Portlet |
updatePortlet(Portlet portlet)
Updates the portlet in the database or adds it if it does not yet exist. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PortletLocalServiceWrapper(PortletLocalService portletLocalService)
| Method Detail |
|---|
public Portlet addPortlet(Portlet portlet)
throws SystemException
addPortlet in interface PortletLocalServiceportlet - the portlet
SystemException - if a system exception occurredpublic Portlet createPortlet(long id)
createPortlet in interface PortletLocalServiceid - the primary key for the new portlet
public Portlet deletePortlet(long id)
throws PortalException,
SystemException
deletePortlet in interface PortletLocalServiceid - the primary key of the portlet
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred
public Portlet deletePortlet(Portlet portlet)
throws SystemException
deletePortlet in interface PortletLocalServiceportlet - the portlet
SystemException - if a system exception occurredpublic DynamicQuery dynamicQuery()
dynamicQuery in interface PortletLocalService
public List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery in interface PortletLocalServicedynamicQuery - the dynamic query
SystemException - if a system exception occurred
public List dynamicQuery(DynamicQuery dynamicQuery,
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.
dynamicQuery in interface PortletLocalServicedynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
SystemException - if a system exception occurred
public List dynamicQuery(DynamicQuery dynamicQuery,
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.
dynamicQuery in interface PortletLocalServicedynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
SystemException - if a system exception occurred
public long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQueryCount in interface PortletLocalServicedynamicQuery - the dynamic query
SystemException - if a system exception occurred
public Portlet fetchPortlet(long id)
throws SystemException
fetchPortlet in interface PortletLocalServiceSystemException
public Portlet getPortlet(long id)
throws PortalException,
SystemException
getPortlet in interface PortletLocalServiceid - the primary key of the portlet
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
getPersistedModel in interface PersistedModelLocalServicegetPersistedModel in interface PortletLocalServicePortalException
SystemException
public List<Portlet> getPortlets(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.
getPortlets in interface PortletLocalServicestart - the lower bound of the range of portletsend - the upper bound of the range of portlets (not inclusive)
SystemException - if a system exception occurred
public int getPortletsCount()
throws SystemException
getPortletsCount in interface PortletLocalServiceSystemException - if a system exception occurred
public Portlet updatePortlet(Portlet portlet)
throws SystemException
updatePortlet in interface PortletLocalServiceportlet - the portlet
SystemException - if a system exception occurredpublic String getBeanIdentifier()
getBeanIdentifier in interface PortletLocalServicepublic void setBeanIdentifier(String beanIdentifier)
setBeanIdentifier in interface PortletLocalServicebeanIdentifier - the Spring bean ID for this bean
public void addPortletCategory(long companyId,
String categoryName)
addPortletCategory in interface PortletLocalService
public void checkPortlet(Portlet portlet)
throws PortalException,
SystemException
checkPortlet in interface PortletLocalServicePortalException
SystemException
public void checkPortlets(long companyId)
throws PortalException,
SystemException
checkPortlets in interface PortletLocalServicePortalException
SystemExceptionpublic void clearCache()
clearCache in interface PortletLocalServicepublic void clearCompanyPortletsPool()
clearCompanyPortletsPool in interface PortletLocalService
public Portlet clonePortlet(long companyId,
String portletId)
clonePortlet(String)
clonePortlet in interface PortletLocalServicepublic Portlet clonePortlet(String portletId)
clonePortlet in interface PortletLocalService
public void deletePortlet(long companyId,
String portletId,
long plid)
throws PortalException,
SystemException
deletePortlet in interface PortletLocalServicePortalException
SystemException
public void deletePortlets(long companyId,
String[] portletIds,
long plid)
throws PortalException,
SystemException
deletePortlets in interface PortletLocalServicePortalException
SystemException
public Portlet deployRemotePortlet(Portlet portlet,
String categoryName)
throws PortalException,
SystemException
deployRemotePortlet in interface PortletLocalServicePortalException
SystemException
public Portlet deployRemotePortlet(Portlet portlet,
String[] categoryNames)
throws PortalException,
SystemException
deployRemotePortlet in interface PortletLocalServicePortalException
SystemExceptionpublic void destroyPortlet(Portlet portlet)
destroyPortlet in interface PortletLocalServicepublic void destroyRemotePortlet(Portlet portlet)
destroyRemotePortlet in interface PortletLocalServicepublic List<CustomAttributesDisplay> getCustomAttributesDisplays()
getCustomAttributesDisplays in interface PortletLocalService
public PortletCategory getEARDisplay(String xml)
throws SystemException
getEARDisplay in interface PortletLocalServiceSystemExceptionpublic List<Portlet> getFriendlyURLMapperPortlets()
getFriendlyURLMapperPortlets in interface PortletLocalServicepublic List<FriendlyURLMapper> getFriendlyURLMappers()
getFriendlyURLMappers in interface PortletLocalServicepublic PortletApp getPortletApp(String servletContextName)
getPortletApp in interface PortletLocalService
public Portlet getPortletById(long companyId,
String portletId)
throws SystemException
getPortletById in interface PortletLocalServiceSystemExceptionpublic Portlet getPortletById(String portletId)
getPortletById in interface PortletLocalService
public Portlet getPortletByStrutsPath(long companyId,
String strutsPath)
throws SystemException
getPortletByStrutsPath in interface PortletLocalServiceSystemExceptionpublic List<Portlet> getPortlets()
getPortlets in interface PortletLocalService
public List<Portlet> getPortlets(long companyId)
throws SystemException
getPortlets in interface PortletLocalServiceSystemException
public List<Portlet> getPortlets(long companyId,
boolean showSystem,
boolean showPortal)
throws SystemException
getPortlets in interface PortletLocalServiceSystemExceptionpublic List<Portlet> getScopablePortlets()
getScopablePortlets in interface PortletLocalService
public PortletCategory getWARDisplay(String servletContextName,
String xml)
throws SystemException
getWARDisplay in interface PortletLocalServiceSystemException
public boolean hasPortlet(long companyId,
String portletId)
throws SystemException
hasPortlet in interface PortletLocalServiceSystemException
public void initEAR(javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
initEAR in interface PortletLocalService
public List<Portlet> initWAR(String servletContextName,
javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
initWAR in interface PortletLocalService
public Map<String,Portlet> loadGetPortletsPool(long companyId)
throws SystemException
loadGetPortletsPool in interface PortletLocalServiceSystemExceptionpublic void removeCompanyPortletsPool(long companyId)
removeCompanyPortletsPool in interface PortletLocalService
public Portlet updatePortlet(long companyId,
String portletId,
String roles,
boolean active)
throws SystemException
updatePortlet in interface PortletLocalServiceSystemExceptionpublic PortletLocalService getWrappedPortletLocalService()
getWrappedService()
public void setWrappedPortletLocalService(PortletLocalService portletLocalService)
setWrappedService(com.liferay.portal.service.PortletLocalService)
public PortletLocalService getWrappedService()
getWrappedService in interface ServiceWrapper<PortletLocalService>public void setWrappedService(PortletLocalService portletLocalService)
setWrappedService in interface ServiceWrapper<PortletLocalService>
|
Liferay 6.2.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||