|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.PortletLocalServiceWrapper
@ProviderType public class PortletLocalServiceWrapper
Provides 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()
Deprecated. As of 7.0.0, replaced by #clearPortletsMap) |
|
void |
clearPortletsMap()
|
|
Portlet |
clonePortlet(long companyId,
String portletId)
Deprecated. As of 6.1.0, replaced by clonePortlet(String) |
|
Portlet |
clonePortlet(String portletId)
|
|
Portlet |
createPortlet(long id)
Creates a new portlet with the primary key. |
|
PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
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)
|
|
Portlet |
deployRemotePortlet(Portlet portlet,
String[] categoryNames,
boolean eagerDestroy)
|
|
void |
destroyPortlet(Portlet portlet)
|
|
void |
destroyRemotePortlet(Portlet portlet)
|
|
DynamicQuery |
dynamicQuery()
|
|
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> 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 matching the dynamic query. |
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
Portlet |
fetchPortlet(long id)
|
|
ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
List<CustomAttributesDisplay> |
getCustomAttributesDisplays()
|
|
PortletCategory |
getEARDisplay(String xml)
|
|
List<Portlet> |
getFriendlyURLMapperPortlets()
|
|
List<FriendlyURLMapper> |
getFriendlyURLMappers()
|
|
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery()
|
|
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
|
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 |
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> |
loadGetPortletsMap(long companyId)
|
|
Map<String,Portlet> |
loadGetPortletsPool(long companyId)
Deprecated. As of 7.0.0, replaced by #loadGetPortletsMap(long)) |
|
void |
removeCompanyPortletsPool(long companyId)
|
|
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)
addPortlet in interface PortletLocalServiceportlet - the portlet
public void addPortletCategory(long companyId,
String categoryName)
addPortletCategory in interface PortletLocalService
public void checkPortlet(Portlet portlet)
throws PortalException
checkPortlet in interface PortletLocalServicePortalException
public void checkPortlets(long companyId)
throws PortalException
checkPortlets in interface PortletLocalServicePortalExceptionpublic void clearCache()
clearCache in interface PortletLocalService@Deprecated public void clearCompanyPortletsPool()
#clearPortletsMap)
clearCompanyPortletsPool in interface PortletLocalServicepublic void clearPortletsMap()
clearPortletsMap in interface PortletLocalService
@Deprecated
public Portlet clonePortlet(long companyId,
String portletId)
clonePortlet(String)
clonePortlet in interface PortletLocalServicepublic Portlet clonePortlet(String portletId)
clonePortlet in interface PortletLocalServicepublic Portlet createPortlet(long id)
createPortlet in interface PortletLocalServiceid - the primary key for the new portlet
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
deletePersistedModel in interface PersistedModelLocalServicedeletePersistedModel in interface PortletLocalServicePortalException
public void deletePortlet(long companyId,
String portletId,
long plid)
throws PortalException
deletePortlet in interface PortletLocalServicePortalException
public Portlet deletePortlet(long id)
throws PortalException
deletePortlet in interface PortletLocalServiceid - the primary key of the portlet
PortalException - if a portlet with the primary key could not be foundpublic Portlet deletePortlet(Portlet portlet)
deletePortlet in interface PortletLocalServiceportlet - the portlet
public void deletePortlets(long companyId,
String[] portletIds,
long plid)
throws PortalException
deletePortlets in interface PortletLocalServicePortalException
public Portlet deployRemotePortlet(Portlet portlet,
String categoryName)
throws PortalException
deployRemotePortlet in interface PortletLocalServicePortalException
public Portlet deployRemotePortlet(Portlet portlet,
String[] categoryNames)
throws PortalException
deployRemotePortlet in interface PortletLocalServicePortalException
public Portlet deployRemotePortlet(Portlet portlet,
String[] categoryNames,
boolean eagerDestroy)
throws PortalException
deployRemotePortlet in interface PortletLocalServicePortalExceptionpublic void destroyPortlet(Portlet portlet)
destroyPortlet in interface PortletLocalServicepublic void destroyRemotePortlet(Portlet portlet)
destroyRemotePortlet in interface PortletLocalServicepublic DynamicQuery dynamicQuery()
dynamicQuery in interface PortletLocalServicepublic <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery in interface PortletLocalServicedynamicQuery - the dynamic query
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
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)
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
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)
public long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQueryCount in interface PortletLocalServicedynamicQuery - the dynamic query
public long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQueryCount in interface PortletLocalServicedynamicQuery - the dynamic queryprojection - the projection to apply to the query
public Portlet fetchPortlet(long id)
fetchPortlet in interface PortletLocalServicepublic ActionableDynamicQuery getActionableDynamicQuery()
getActionableDynamicQuery in interface PortletLocalServicepublic List<CustomAttributesDisplay> getCustomAttributesDisplays()
getCustomAttributesDisplays in interface PortletLocalServicepublic PortletCategory getEARDisplay(String xml)
getEARDisplay in interface PortletLocalServicepublic List<Portlet> getFriendlyURLMapperPortlets()
getFriendlyURLMapperPortlets in interface PortletLocalServicepublic List<FriendlyURLMapper> getFriendlyURLMappers()
getFriendlyURLMappers in interface PortletLocalServicepublic IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
getIndexableActionableDynamicQuery in interface PortletLocalServicepublic String getOSGiServiceIdentifier()
getOSGiServiceIdentifier in interface PortletLocalService
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
getPersistedModel in interface PersistedModelLocalServicegetPersistedModel in interface PortletLocalServicePortalException
public Portlet getPortlet(long id)
throws PortalException
getPortlet in interface PortletLocalServiceid - the primary key of the portlet
PortalException - if a portlet with the primary key could not be foundpublic PortletApp getPortletApp(String servletContextName)
getPortletApp in interface PortletLocalService
public Portlet getPortletById(long companyId,
String portletId)
getPortletById in interface PortletLocalServicepublic Portlet getPortletById(String portletId)
getPortletById in interface PortletLocalService
public Portlet getPortletByStrutsPath(long companyId,
String strutsPath)
getPortletByStrutsPath in interface PortletLocalServicepublic List<Portlet> getPortlets()
getPortlets in interface PortletLocalServicepublic List<Portlet> getPortlets(long companyId)
getPortlets in interface PortletLocalService
public List<Portlet> getPortlets(long companyId,
boolean showSystem,
boolean showPortal)
getPortlets in interface PortletLocalService
public List<Portlet> getPortlets(int start,
int end)
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)
public int getPortletsCount()
getPortletsCount in interface PortletLocalServicepublic List<Portlet> getScopablePortlets()
getScopablePortlets in interface PortletLocalService
public PortletCategory getWARDisplay(String servletContextName,
String xml)
getWARDisplay in interface PortletLocalService
public boolean hasPortlet(long companyId,
String portletId)
hasPortlet in interface PortletLocalService
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 PortletLocalServicepublic Map<String,Portlet> loadGetPortletsMap(long companyId)
loadGetPortletsMap in interface PortletLocalService@Deprecated public Map<String,Portlet> loadGetPortletsPool(long companyId)
#loadGetPortletsMap(long))
loadGetPortletsPool in interface PortletLocalServicepublic void removeCompanyPortletsPool(long companyId)
removeCompanyPortletsPool in interface PortletLocalService
public Portlet updatePortlet(long companyId,
String portletId,
String roles,
boolean active)
updatePortlet in interface PortletLocalServicepublic Portlet updatePortlet(Portlet portlet)
updatePortlet in interface PortletLocalServiceportlet - the portlet
public PortletLocalService getWrappedService()
getWrappedService in interface ServiceWrapper<PortletLocalService>public void setWrappedService(PortletLocalService portletLocalService)
setWrappedService in interface ServiceWrapper<PortletLocalService>
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||