Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface PortletLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
PortletLocalServiceBaseImpl, PortletLocalServiceImpl, PortletLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface PortletLocalService
extends BaseLocalService, PersistedModelLocalService

Provides 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.

See Also:
PortletLocalServiceUtil, PortletLocalServiceBaseImpl, PortletLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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()
           
 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.
 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)
           
 void destroyPortlet(Portlet portlet)
           
 void destroyRemotePortlet(Portlet portlet)
           
 DynamicQuery dynamicQuery()
           
 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)
          Returns the number of rows that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 Portlet fetchPortlet(long id)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<CustomAttributesDisplay> getCustomAttributesDisplays()
           
 PortletCategory getEARDisplay(String xml)
           
 List<Portlet> getFriendlyURLMapperPortlets()
           
 List<FriendlyURLMapper> getFriendlyURLMappers()
           
 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> loadGetPortletsPool(long companyId)
           
 void removeCompanyPortletsPool(long companyId)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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

addPortlet

@Indexable(type=REINDEX)
Portlet addPortlet(Portlet portlet)
                   throws SystemException
Adds the portlet to the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet
Returns:
the portlet that was added
Throws:
SystemException - if a system exception occurred

createPortlet

Portlet createPortlet(long id)
Creates a new portlet with the primary key. Does not add the portlet to the database.

Parameters:
id - the primary key for the new portlet
Returns:
the new portlet

deletePortlet

@Indexable(type=DELETE)
Portlet deletePortlet(long id)
                      throws PortalException,
                             SystemException
Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
id - the primary key of the portlet
Returns:
the portlet that was removed
Throws:
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred

deletePortlet

@Indexable(type=DELETE)
Portlet deletePortlet(Portlet portlet)
                      throws SystemException
Deletes the portlet from the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet
Returns:
the portlet that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

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.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

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.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet fetchPortlet(long id)
                     throws SystemException
Throws:
SystemException

getPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortlet(long id)
                   throws PortalException,
                          SystemException
Returns the portlet with the primary key.

Parameters:
id - the primary key of the portlet
Returns:
the portlet
Throws:
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getPortlets(int start,
                                                                   int end)
                          throws SystemException
Returns a range of all the portlets.

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.

Parameters:
start - the lower bound of the range of portlets
end - the upper bound of the range of portlets (not inclusive)
Returns:
the range of portlets
Throws:
SystemException - if a system exception occurred

getPortletsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPortletsCount()
                     throws SystemException
Returns the number of portlets.

Returns:
the number of portlets
Throws:
SystemException - if a system exception occurred

updatePortlet

@Indexable(type=REINDEX)
Portlet updatePortlet(Portlet portlet)
                      throws SystemException
Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet
Returns:
the portlet that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addPortletCategory

@Skip
void addPortletCategory(long companyId,
                             String categoryName)

checkPortlet

void checkPortlet(Portlet portlet)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

checkPortlets

void checkPortlets(long companyId)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

clearCache

@Skip
void clearCache()

clearCompanyPortletsPool

@Clusterable
@Transactional(enabled=false)
void clearCompanyPortletsPool()

clonePortlet

@Skip
Portlet clonePortlet(long companyId,
                          String portletId)
Deprecated. As of 6.1.0, replaced by clonePortlet(String)


clonePortlet

@Skip
Portlet clonePortlet(String portletId)

deletePortlet

void deletePortlet(long companyId,
                   String portletId,
                   long plid)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

deletePortlets

void deletePortlets(long companyId,
                    String[] portletIds,
                    long plid)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

deployRemotePortlet

Portlet deployRemotePortlet(Portlet portlet,
                            String categoryName)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

deployRemotePortlet

Portlet deployRemotePortlet(Portlet portlet,
                            String[] categoryNames)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

destroyPortlet

@Skip
void destroyPortlet(Portlet portlet)

destroyRemotePortlet

@Skip
void destroyRemotePortlet(Portlet portlet)

getCustomAttributesDisplays

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CustomAttributesDisplay> getCustomAttributesDisplays()

getEARDisplay

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletCategory getEARDisplay(String xml)
                              throws SystemException
Throws:
SystemException

getFriendlyURLMapperPortlets

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getFriendlyURLMapperPortlets()

getFriendlyURLMappers

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<FriendlyURLMapper> getFriendlyURLMappers()

getPortletApp

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletApp getPortletApp(String servletContextName)

getPortletById

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortletById(long companyId,
                                                                     String portletId)
                       throws SystemException
Throws:
SystemException

getPortletById

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortletById(String portletId)

getPortletByStrutsPath

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortletByStrutsPath(long companyId,
                                                                             String strutsPath)
                               throws SystemException
Throws:
SystemException

getPortlets

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getPortlets()

getPortlets

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getPortlets(long companyId)
                          throws SystemException
Throws:
SystemException

getPortlets

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getPortlets(long companyId,
                                                                        boolean showSystem,
                                                                        boolean showPortal)
                          throws SystemException
Throws:
SystemException

getScopablePortlets

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getScopablePortlets()

getWARDisplay

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletCategory getWARDisplay(String servletContextName,
                                                                            String xml)
                              throws SystemException
Throws:
SystemException

hasPortlet

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasPortlet(long companyId,
                                                                 String portletId)
                   throws SystemException
Throws:
SystemException

initEAR

@Skip
void initEAR(javax.servlet.ServletContext servletContext,
                  String[] xmls,
                  PluginPackage pluginPackage)

initWAR

@Skip
List<Portlet> initWAR(String servletContextName,
                           javax.servlet.ServletContext servletContext,
                           String[] xmls,
                           PluginPackage pluginPackage)

loadGetPortletsPool

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<String,Portlet> loadGetPortletsPool(long companyId)
                                        throws SystemException
Throws:
SystemException

removeCompanyPortletsPool

@Clusterable
@Transactional(enabled=false)
void removeCompanyPortletsPool(long companyId)

updatePortlet

Portlet updatePortlet(long companyId,
                      String portletId,
                      String roles,
                      boolean active)
                      throws SystemException
Throws:
SystemException

Liferay 6.2-ce-ga5