|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.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 |
checkPortlet(Portlet portlet)
|
void |
checkPortlets(long companyId)
|
void |
clearCache()
|
Portlet |
clonePortlet(long companyId,
String portletId)
|
Portlet |
createPortlet(long id)
Creates a new portlet with the primary key. |
void |
deletePortlet(long id)
Deletes the portlet with the primary key from the database. |
void |
deletePortlet(Portlet portlet)
Deletes the portlet from the database. |
Portlet |
deployRemotePortlet(Portlet portlet,
String categoryName)
|
void |
destroyPortlet(Portlet portlet)
|
void |
destroyRemotePortlet(Portlet portlet)
|
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)
Counts the number of rows that match the dynamic query. |
List<CustomAttributesDisplay> |
getCustomAttributesDisplays()
|
PortletCategory |
getEARDisplay(String xml)
|
List<Portlet> |
getFriendlyURLMapperPortlets()
|
List<FriendlyURLMapper> |
getFriendlyURLMappers()
|
Portlet |
getPortlet(long id)
Gets 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)
Gets a range of all the portlets. |
List<Portlet> |
getPortlets(long companyId)
|
List<Portlet> |
getPortlets(long companyId,
boolean showSystem,
boolean showPortal)
|
int |
getPortletsCount()
Gets the number of portlets. |
PortletCategory |
getWARDisplay(String servletContextName,
String xml)
|
PortletLocalService |
getWrappedPortletLocalService()
|
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)
|
Portlet |
updatePortlet(long companyId,
String portletId,
String roles,
boolean active)
|
Portlet |
updatePortlet(Portlet portlet)
Updates the portlet in the database. |
Portlet |
updatePortlet(Portlet portlet,
boolean merge)
Updates the portlet in the database. |
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 PortletLocalService
portlet
- the portlet to add
SystemException
- if a system exception occurredpublic Portlet createPortlet(long id)
createPortlet
in interface PortletLocalService
id
- the primary key for the new portlet
public void deletePortlet(long id) throws PortalException, SystemException
deletePortlet
in interface PortletLocalService
id
- the primary key of the portlet to delete
PortalException
- if a portlet with the primary key could not be found
SystemException
- if a system exception occurredpublic void deletePortlet(Portlet portlet) throws SystemException
deletePortlet
in interface PortletLocalService
portlet
- the portlet to delete
SystemException
- if a system exception occurredpublic List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
in interface PortletLocalService
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic 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.
dynamicQuery
in interface PortletLocalService
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)
SystemException
- if a system exception occurredpublic 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.
dynamicQuery
in interface PortletLocalService
dynamicQuery
- the dynamic query to search withstart
- the lower bound of the range of model instances to returnend
- the upper bound of the range of model instances to return (not inclusive)orderByComparator
- the comparator to order the results by
SystemException
- if a system exception occurredpublic long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQueryCount
in interface PortletLocalService
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic Portlet getPortlet(long id) throws PortalException, SystemException
getPortlet
in interface PortletLocalService
id
- the primary key of the portlet to get
PortalException
- if a portlet with the primary key could not be found
SystemException
- if a system exception occurredpublic 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.
getPortlets
in interface PortletLocalService
start
- the lower bound of the range of portlets to returnend
- the upper bound of the range of portlets to return (not inclusive)
SystemException
- if a system exception occurredpublic int getPortletsCount() throws SystemException
getPortletsCount
in interface PortletLocalService
SystemException
- if a system exception occurredpublic Portlet updatePortlet(Portlet portlet) throws SystemException
updatePortlet
in interface PortletLocalService
portlet
- the portlet to update
SystemException
- if a system exception occurredpublic Portlet updatePortlet(Portlet portlet, boolean merge) throws SystemException
updatePortlet
in interface PortletLocalService
portlet
- the portlet to updatemerge
- whether to merge the portlet with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)
for an explanation.
SystemException
- if a system exception occurredpublic void checkPortlet(Portlet portlet) throws PortalException, SystemException
checkPortlet
in interface PortletLocalService
PortalException
SystemException
public void checkPortlets(long companyId) throws PortalException, SystemException
checkPortlets
in interface PortletLocalService
PortalException
SystemException
public void clearCache()
clearCache
in interface PortletLocalService
public Portlet clonePortlet(long companyId, String portletId) throws SystemException
clonePortlet
in interface PortletLocalService
SystemException
public Portlet deployRemotePortlet(Portlet portlet, String categoryName) throws SystemException
deployRemotePortlet
in interface PortletLocalService
SystemException
public void destroyPortlet(Portlet portlet)
destroyPortlet
in interface PortletLocalService
public void destroyRemotePortlet(Portlet portlet)
destroyRemotePortlet
in interface PortletLocalService
public List<CustomAttributesDisplay> getCustomAttributesDisplays()
getCustomAttributesDisplays
in interface PortletLocalService
public PortletCategory getEARDisplay(String xml) throws SystemException
getEARDisplay
in interface PortletLocalService
SystemException
public List<Portlet> getFriendlyURLMapperPortlets()
getFriendlyURLMapperPortlets
in interface PortletLocalService
public List<FriendlyURLMapper> getFriendlyURLMappers()
getFriendlyURLMappers
in interface PortletLocalService
public PortletApp getPortletApp(String servletContextName)
getPortletApp
in interface PortletLocalService
public Portlet getPortletById(long companyId, String portletId) throws SystemException
getPortletById
in interface PortletLocalService
SystemException
public Portlet getPortletById(String portletId)
getPortletById
in interface PortletLocalService
public Portlet getPortletByStrutsPath(long companyId, String strutsPath) throws SystemException
getPortletByStrutsPath
in interface PortletLocalService
SystemException
public List<Portlet> getPortlets()
getPortlets
in interface PortletLocalService
public List<Portlet> getPortlets(long companyId) throws SystemException
getPortlets
in interface PortletLocalService
SystemException
public List<Portlet> getPortlets(long companyId, boolean showSystem, boolean showPortal) throws SystemException
getPortlets
in interface PortletLocalService
SystemException
public PortletCategory getWARDisplay(String servletContextName, String xml) throws SystemException
getWARDisplay
in interface PortletLocalService
SystemException
public boolean hasPortlet(long companyId, String portletId) throws SystemException
hasPortlet
in interface PortletLocalService
SystemException
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 Portlet updatePortlet(long companyId, String portletId, String roles, boolean active) throws SystemException
updatePortlet
in interface PortletLocalService
SystemException
public PortletLocalService getWrappedPortletLocalService()
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |