|
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.PortletLocalServiceUtil
@ProviderType public class PortletLocalServiceUtil
Provides the local service utility for Portlet. This utility wraps
com.liferay.portal.service.impl.PortletLocalServiceImpl and is the
primary access point for service operations in application layer code running
on the local server. 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.
PortletLocalService,
PortletLocalServiceBaseImpl,
com.liferay.portal.service.impl.PortletLocalServiceImpl| Constructor Summary | |
|---|---|
PortletLocalServiceUtil()
|
|
| Method Summary | ||
|---|---|---|
static Portlet |
addPortlet(Portlet portlet)
Adds the portlet to the database. |
|
static void |
addPortletCategory(long companyId,
String categoryName)
|
|
static void |
checkPortlet(Portlet portlet)
|
|
static void |
checkPortlets(long companyId)
|
|
static void |
clearCache()
|
|
static void |
clearCompanyPortletsPool()
Deprecated. As of 7.0.0, replaced by #clearPortletsMap) |
|
static void |
clearPortletsMap()
|
|
static Portlet |
clonePortlet(long companyId,
String portletId)
Deprecated. As of 6.1.0, replaced by clonePortlet(String) |
|
static Portlet |
clonePortlet(String portletId)
|
|
static Portlet |
createPortlet(long id)
Creates a new portlet with the primary key. |
|
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
static Portlet |
deletePortlet(long id)
Deletes the portlet with the primary key from the database. |
|
static void |
deletePortlet(long companyId,
String portletId,
long plid)
|
|
static Portlet |
deletePortlet(Portlet portlet)
Deletes the portlet from the database. |
|
static void |
deletePortlets(long companyId,
String[] portletIds,
long plid)
|
|
static Portlet |
deployRemotePortlet(Portlet portlet,
String categoryName)
|
|
static Portlet |
deployRemotePortlet(Portlet portlet,
String[] categoryNames)
|
|
static Portlet |
deployRemotePortlet(Portlet portlet,
String[] categoryNames,
boolean eagerDestroy)
|
|
static void |
destroyPortlet(Portlet portlet)
|
|
static void |
destroyRemotePortlet(Portlet portlet)
|
|
static DynamicQuery |
dynamicQuery()
|
|
static
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
static
|
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. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
static Portlet |
fetchPortlet(long id)
|
|
static ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
static List<CustomAttributesDisplay> |
getCustomAttributesDisplays()
|
|
static PortletCategory |
getEARDisplay(String xml)
|
|
static List<Portlet> |
getFriendlyURLMapperPortlets()
|
|
static List<FriendlyURLMapper> |
getFriendlyURLMappers()
|
|
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery()
|
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
static Portlet |
getPortlet(long id)
Returns the portlet with the primary key. |
|
static PortletApp |
getPortletApp(String servletContextName)
|
|
static Portlet |
getPortletById(long companyId,
String portletId)
|
|
static Portlet |
getPortletById(String portletId)
|
|
static Portlet |
getPortletByStrutsPath(long companyId,
String strutsPath)
|
|
static List<Portlet> |
getPortlets()
|
|
static List<Portlet> |
getPortlets(int start,
int end)
Returns a range of all the portlets. |
|
static List<Portlet> |
getPortlets(long companyId)
|
|
static List<Portlet> |
getPortlets(long companyId,
boolean showSystem,
boolean showPortal)
|
|
static int |
getPortletsCount()
Returns the number of portlets. |
|
static List<Portlet> |
getScopablePortlets()
|
|
static PortletLocalService |
getService()
|
|
static PortletCategory |
getWARDisplay(String servletContextName,
String xml)
|
|
static boolean |
hasPortlet(long companyId,
String portletId)
|
|
static void |
initEAR(javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
|
|
static List<Portlet> |
initWAR(String servletContextName,
javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
|
|
static Map<String,Portlet> |
loadGetPortletsMap(long companyId)
|
|
static Map<String,Portlet> |
loadGetPortletsPool(long companyId)
Deprecated. As of 7.0.0, replaced by #loadGetPortletsMap(long)) |
|
static void |
removeCompanyPortletsPool(long companyId)
|
|
static Portlet |
updatePortlet(long companyId,
String portletId,
String roles,
boolean active)
|
|
static 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 PortletLocalServiceUtil()
| Method Detail |
|---|
public static Portlet addPortlet(Portlet portlet)
portlet - the portlet
public static void addPortletCategory(long companyId,
String categoryName)
public static void checkPortlet(Portlet portlet)
throws PortalException
PortalException
public static void checkPortlets(long companyId)
throws PortalException
PortalExceptionpublic static void clearCache()
@Deprecated public static void clearCompanyPortletsPool()
#clearPortletsMap)
public static void clearPortletsMap()
@Deprecated
public static Portlet clonePortlet(long companyId,
String portletId)
clonePortlet(String)
public static Portlet clonePortlet(String portletId)
public static Portlet createPortlet(long id)
id - the primary key for the new portlet
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
PortalException
public static void deletePortlet(long companyId,
String portletId,
long plid)
throws PortalException
PortalException
public static Portlet deletePortlet(long id)
throws PortalException
id - the primary key of the portlet
PortalException - if a portlet with the primary key could not be foundpublic static Portlet deletePortlet(Portlet portlet)
portlet - the portlet
public static void deletePortlets(long companyId,
String[] portletIds,
long plid)
throws PortalException
PortalException
public static Portlet deployRemotePortlet(Portlet portlet,
String categoryName)
throws PortalException
PortalException
public static Portlet deployRemotePortlet(Portlet portlet,
String[] categoryNames)
throws PortalException
PortalException
public static Portlet deployRemotePortlet(Portlet portlet,
String[] categoryNames,
boolean eagerDestroy)
throws PortalException
PortalExceptionpublic static void destroyPortlet(Portlet portlet)
public static void destroyRemotePortlet(Portlet portlet)
public static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static <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)
public static <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)
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
public static Portlet fetchPortlet(long id)
public static ActionableDynamicQuery getActionableDynamicQuery()
public static List<CustomAttributesDisplay> getCustomAttributesDisplays()
public static PortletCategory getEARDisplay(String xml)
public static List<Portlet> getFriendlyURLMapperPortlets()
public static List<FriendlyURLMapper> getFriendlyURLMappers()
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
PortalException
public static Portlet getPortlet(long id)
throws PortalException
id - the primary key of the portlet
PortalException - if a portlet with the primary key could not be foundpublic static PortletApp getPortletApp(String servletContextName)
public static Portlet getPortletById(long companyId,
String portletId)
public static Portlet getPortletById(String portletId)
public static Portlet getPortletByStrutsPath(long companyId,
String strutsPath)
public static List<Portlet> getPortlets()
public static List<Portlet> getPortlets(long companyId)
public static List<Portlet> getPortlets(long companyId,
boolean showSystem,
boolean showPortal)
public static 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)
public static int getPortletsCount()
public static List<Portlet> getScopablePortlets()
public static PortletCategory getWARDisplay(String servletContextName,
String xml)
public static boolean hasPortlet(long companyId,
String portletId)
public static void initEAR(javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
public static List<Portlet> initWAR(String servletContextName,
javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
public static Map<String,Portlet> loadGetPortletsMap(long companyId)
@Deprecated public static Map<String,Portlet> loadGetPortletsPool(long companyId)
#loadGetPortletsMap(long))
public static void removeCompanyPortletsPool(long companyId)
public static Portlet updatePortlet(long companyId,
String portletId,
String roles,
boolean active)
public static Portlet updatePortlet(Portlet portlet)
portlet - the portlet
public static PortletLocalService getService()
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||