|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface PortletLocalServiceProvides the local service interface for Portlet. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
PortletLocalServiceUtil,
PortletLocalServiceBaseImpl,
com.liferay.portal.service.impl.PortletLocalServiceImpl| 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)
|
|
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)
|
|
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. |
|
| Method Detail |
|---|
@Indexable(type=REINDEX) Portlet addPortlet(Portlet portlet)
portlet - the portlet
@Skip
void addPortletCategory(long companyId,
String categoryName)
void checkPortlet(Portlet portlet)
throws PortalException
PortalException
void checkPortlets(long companyId)
throws PortalException
PortalException@Skip void clearCache()
@Clusterable @Deprecated @Transactional(enabled=false) void clearCompanyPortletsPool()
#clearPortletsMap)
@Clusterable @Transactional(enabled=false) void clearPortletsMap()
@Deprecated
@Skip
Portlet clonePortlet(long companyId,
String portletId)
clonePortlet(String)
@Skip Portlet clonePortlet(String portletId)
Portlet createPortlet(long id)
id - the primary key for the new portlet
PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
deletePersistedModel in interface PersistedModelLocalServicePortalException
void deletePortlet(long companyId,
String portletId,
long plid)
throws PortalException
PortalException
@Indexable(type=DELETE)
Portlet deletePortlet(long id)
throws PortalException
id - the primary key of the portlet
PortalException - if a portlet with the primary key could not be found@Indexable(type=DELETE) Portlet deletePortlet(Portlet portlet)
portlet - the portlet
void deletePortlets(long companyId,
String[] portletIds,
long plid)
throws PortalException
PortalException
Portlet deployRemotePortlet(Portlet portlet,
String categoryName)
throws PortalException
PortalException
Portlet deployRemotePortlet(Portlet portlet,
String[] categoryNames)
throws PortalException
PortalException
Portlet deployRemotePortlet(Portlet portlet,
String[] categoryNames,
boolean eagerDestroy)
throws PortalException
PortalException@Skip void destroyPortlet(Portlet portlet)
@Skip void destroyRemotePortlet(Portlet portlet)
DynamicQuery dynamicQuery()
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
<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 - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
<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 - 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)
long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
@Transactional(propagation=SUPPORTS,
readOnly=true)
Portlet fetchPortlet(long id)
@Transactional(propagation=SUPPORTS,
readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<CustomAttributesDisplay> getCustomAttributesDisplays()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
PortletCategory getEARDisplay(String xml)
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Portlet> getFriendlyURLMapperPortlets()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<FriendlyURLMapper> getFriendlyURLMappers()
@Transactional(propagation=SUPPORTS,
readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS,
readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
getPersistedModel in interface PersistedModelLocalServicePortalException
@Transactional(propagation=SUPPORTS,
readOnly=true)
Portlet getPortlet(long id)
throws PortalException
id - the primary key of the portlet
PortalException - if a portlet with the primary key could not be found
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
PortletApp getPortletApp(String servletContextName)
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
Portlet getPortletById(long companyId,
String portletId)
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
Portlet getPortletById(String portletId)
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
Portlet getPortletByStrutsPath(long companyId,
String strutsPath)
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Portlet> getPortlets()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Portlet> getPortlets(long companyId)
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Portlet> getPortlets(long companyId,
boolean showSystem,
boolean showPortal)
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
start - the lower bound of the range of portletsend - the upper bound of the range of portlets (not inclusive)
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getPortletsCount()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Portlet> getScopablePortlets()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
PortletCategory getWARDisplay(String servletContextName,
String xml)
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasPortlet(long companyId,
String portletId)
@Skip
void initEAR(javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
@Skip
List<Portlet> initWAR(String servletContextName,
javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
@Transactional(propagation=SUPPORTS,
readOnly=true)
Map<String,Portlet> loadGetPortletsMap(long companyId)
@Deprecated
@Transactional(propagation=SUPPORTS,
readOnly=true)
Map<String,Portlet> loadGetPortletsPool(long companyId)
#loadGetPortletsMap(long))
@Clusterable @Transactional(enabled=false) void removeCompanyPortletsPool(long companyId)
Portlet updatePortlet(long companyId,
String portletId,
String roles,
boolean active)
@Indexable(type=REINDEX) Portlet updatePortlet(Portlet portlet)
portlet - the portlet
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||