|
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.PortletLocalServiceUtil
public class PortletLocalServiceUtil
The utility for the portlet local service. This utility wraps PortletLocalServiceImpl
and is the primary access point for service operations in application layer code running on the local server.
Never modify this class directly. Add custom service methods to PortletLocalServiceImpl
and rerun ServiceBuilder to regenerate this class.
This is a local service. 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
,
PortletLocalServiceImpl
Constructor Summary | |
---|---|
PortletLocalServiceUtil()
|
Method Summary | |
---|---|
static Portlet |
addPortlet(Portlet portlet)
Adds the portlet to the database. |
static void |
checkPortlet(Portlet portlet)
|
static void |
checkPortlets(long companyId)
|
static void |
clearCache()
|
static Portlet |
clonePortlet(long companyId,
String portletId)
|
static Portlet |
createPortlet(long id)
Creates a new portlet with the primary key. |
static void |
deletePortlet(long id)
Deletes the portlet with the primary key from the database. |
static void |
deletePortlet(Portlet portlet)
Deletes the portlet from the database. |
static Portlet |
deployRemotePortlet(Portlet portlet,
String categoryName)
|
static void |
destroyPortlet(Portlet portlet)
|
static void |
destroyRemotePortlet(Portlet portlet)
|
static List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
static 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. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Counts the number of rows that match the dynamic query. |
static List<CustomAttributesDisplay> |
getCustomAttributesDisplays()
|
static PortletCategory |
getEARDisplay(String xml)
|
static List<Portlet> |
getFriendlyURLMapperPortlets()
|
static List<FriendlyURLMapper> |
getFriendlyURLMappers()
|
static Portlet |
getPortlet(long id)
Gets 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)
Gets 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()
Gets the number of portlets. |
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)
|
void |
setService(PortletLocalService service)
|
static Portlet |
updatePortlet(long companyId,
String portletId,
String roles,
boolean active)
|
static Portlet |
updatePortlet(Portlet portlet)
Updates the portlet in the database. |
static 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 PortletLocalServiceUtil()
Method Detail |
---|
public static Portlet addPortlet(Portlet portlet) throws SystemException
portlet
- the portlet to add
SystemException
- if a system exception occurredpublic static Portlet createPortlet(long id)
id
- the primary key for the new portlet
public static void deletePortlet(long id) throws PortalException, SystemException
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 static void deletePortlet(Portlet portlet) throws SystemException
portlet
- the portlet to delete
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static 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
- 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 static 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
- 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 static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query to search with
SystemException
- if a system exception occurredpublic static Portlet getPortlet(long id) throws PortalException, SystemException
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 static 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.
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 static int getPortletsCount() throws SystemException
SystemException
- if a system exception occurredpublic static Portlet updatePortlet(Portlet portlet) throws SystemException
portlet
- the portlet to update
SystemException
- if a system exception occurredpublic static Portlet updatePortlet(Portlet portlet, boolean merge) throws SystemException
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 static void checkPortlet(Portlet portlet) throws PortalException, SystemException
PortalException
SystemException
public static void checkPortlets(long companyId) throws PortalException, SystemException
PortalException
SystemException
public static void clearCache()
public static Portlet clonePortlet(long companyId, String portletId) throws SystemException
SystemException
public static Portlet deployRemotePortlet(Portlet portlet, String categoryName) throws SystemException
SystemException
public static void destroyPortlet(Portlet portlet)
public static void destroyRemotePortlet(Portlet portlet)
public static List<CustomAttributesDisplay> getCustomAttributesDisplays()
public static PortletCategory getEARDisplay(String xml) throws SystemException
SystemException
public static List<Portlet> getFriendlyURLMapperPortlets()
public static List<FriendlyURLMapper> getFriendlyURLMappers()
public static PortletApp getPortletApp(String servletContextName)
public static Portlet getPortletById(long companyId, String portletId) throws SystemException
SystemException
public static Portlet getPortletById(String portletId)
public static Portlet getPortletByStrutsPath(long companyId, String strutsPath) throws SystemException
SystemException
public static List<Portlet> getPortlets()
public static List<Portlet> getPortlets(long companyId) throws SystemException
SystemException
public static List<Portlet> getPortlets(long companyId, boolean showSystem, boolean showPortal) throws SystemException
SystemException
public static PortletCategory getWARDisplay(String servletContextName, String xml) throws SystemException
SystemException
public static boolean hasPortlet(long companyId, String portletId) throws SystemException
SystemException
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 Portlet updatePortlet(long companyId, String portletId, String roles, boolean active) throws SystemException
SystemException
public static PortletLocalService getService()
public void setService(PortletLocalService service)
|
Liferay 6.0.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |