|
Liferay 6.2.0 | |||||||||
| 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,
PortletLocalServiceImpl| Method Summary | |
|---|---|
abstract Portlet |
addPortlet(Portlet portlet)
Adds the portlet to the database. |
abstract void |
addPortletCategory(long companyId,
String categoryName)
|
abstract void |
checkPortlet(Portlet portlet)
|
abstract void |
checkPortlets(long companyId)
|
abstract void |
clearCache()
|
abstract void |
clearCompanyPortletsPool()
|
abstract Portlet |
clonePortlet(long companyId,
String portletId)
Deprecated. As of 6.1.0, replaced by clonePortlet(String) |
abstract Portlet |
clonePortlet(String portletId)
|
abstract Portlet |
createPortlet(long id)
Creates a new portlet with the primary key. |
abstract Portlet |
deletePortlet(long id)
Deletes the portlet with the primary key from the database. |
abstract void |
deletePortlet(long companyId,
String portletId,
long plid)
|
abstract Portlet |
deletePortlet(Portlet portlet)
Deletes the portlet from the database. |
abstract void |
deletePortlets(long companyId,
String[] portletIds,
long plid)
|
abstract Portlet |
deployRemotePortlet(Portlet portlet,
String categoryName)
|
abstract Portlet |
deployRemotePortlet(Portlet portlet,
String[] categoryNames)
|
abstract void |
destroyPortlet(Portlet portlet)
|
abstract void |
destroyRemotePortlet(Portlet portlet)
|
abstract DynamicQuery |
dynamicQuery()
|
abstract List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
abstract List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
abstract 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. |
abstract long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
abstract long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query. |
abstract Portlet |
fetchPortlet(long id)
|
abstract String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
abstract List<CustomAttributesDisplay> |
getCustomAttributesDisplays()
|
abstract PortletCategory |
getEARDisplay(String xml)
|
abstract List<Portlet> |
getFriendlyURLMapperPortlets()
|
abstract List<FriendlyURLMapper> |
getFriendlyURLMappers()
|
abstract PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
abstract Portlet |
getPortlet(long id)
Returns the portlet with the primary key. |
abstract PortletApp |
getPortletApp(String servletContextName)
|
abstract Portlet |
getPortletById(long companyId,
String portletId)
|
abstract Portlet |
getPortletById(String portletId)
|
abstract Portlet |
getPortletByStrutsPath(long companyId,
String strutsPath)
|
abstract List<Portlet> |
getPortlets()
|
abstract List<Portlet> |
getPortlets(int start,
int end)
Returns a range of all the portlets. |
abstract List<Portlet> |
getPortlets(long companyId)
|
abstract List<Portlet> |
getPortlets(long companyId,
boolean showSystem,
boolean showPortal)
|
abstract int |
getPortletsCount()
Returns the number of portlets. |
abstract List<Portlet> |
getScopablePortlets()
|
abstract PortletCategory |
getWARDisplay(String servletContextName,
String xml)
|
abstract boolean |
hasPortlet(long companyId,
String portletId)
|
abstract void |
initEAR(javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
|
abstract List<Portlet> |
initWAR(String servletContextName,
javax.servlet.ServletContext servletContext,
String[] xmls,
PluginPackage pluginPackage)
|
abstract Map<String,Portlet> |
loadGetPortletsPool(long companyId)
|
abstract void |
removeCompanyPortletsPool(long companyId)
|
abstract void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
abstract Portlet |
updatePortlet(long companyId,
String portletId,
String roles,
boolean active)
|
abstract 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)
throws SystemException
portlet - the portlet
SystemException - if a system exception occurredPortlet createPortlet(long id)
id - the primary key for the new portlet
@Indexable(type=DELETE)
Portlet deletePortlet(long id)
throws PortalException,
SystemException
id - the primary key of the portlet
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred
@Indexable(type=DELETE)
Portlet deletePortlet(Portlet portlet)
throws SystemException
portlet - the portlet
SystemException - if a system exception occurredDynamicQuery dynamicQuery()
List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
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. 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)
SystemException - if a system exception occurred
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. 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)
SystemException - if a system exception occurred
long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
throws SystemException
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
Portlet fetchPortlet(long id)
throws SystemException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
Portlet getPortlet(long id)
throws PortalException,
SystemException
id - the primary key of the portlet
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
getPersistedModel in interface PersistedModelLocalServicePortalException
SystemException
@Transactional(propagation=SUPPORTS,
readOnly=true)
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. 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)
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getPortletsCount()
throws SystemException
SystemException - if a system exception occurred
@Indexable(type=REINDEX)
Portlet updatePortlet(Portlet portlet)
throws SystemException
portlet - the portlet
SystemException - if a system exception occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
@Skip
void addPortletCategory(long companyId,
String categoryName)
void checkPortlet(Portlet portlet)
throws PortalException,
SystemException
PortalException
SystemException
void checkPortlets(long companyId)
throws PortalException,
SystemException
PortalException
SystemException@Skip void clearCache()
@Clusterable @Transactional(enabled=false) void clearCompanyPortletsPool()
@Skip
Portlet clonePortlet(long companyId,
String portletId)
clonePortlet(String)
@Skip Portlet clonePortlet(String portletId)
void deletePortlet(long companyId,
String portletId,
long plid)
throws PortalException,
SystemException
PortalException
SystemException
void deletePortlets(long companyId,
String[] portletIds,
long plid)
throws PortalException,
SystemException
PortalException
SystemException
Portlet deployRemotePortlet(Portlet portlet,
String categoryName)
throws PortalException,
SystemException
PortalException
SystemException
Portlet deployRemotePortlet(Portlet portlet,
String[] categoryNames)
throws PortalException,
SystemException
PortalException
SystemException@Skip void destroyPortlet(Portlet portlet)
@Skip void destroyRemotePortlet(Portlet portlet)
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<CustomAttributesDisplay> getCustomAttributesDisplays()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
PortletCategory getEARDisplay(String xml)
throws SystemException
SystemException
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Portlet> getFriendlyURLMapperPortlets()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<FriendlyURLMapper> getFriendlyURLMappers()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
PortletApp getPortletApp(String servletContextName)
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
Portlet getPortletById(long companyId,
String portletId)
throws SystemException
SystemException
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
Portlet getPortletById(String portletId)
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
Portlet getPortletByStrutsPath(long companyId,
String strutsPath)
throws SystemException
SystemException
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Portlet> getPortlets()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Portlet> getPortlets(long companyId)
throws SystemException
SystemException
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Portlet> getPortlets(long companyId,
boolean showSystem,
boolean showPortal)
throws SystemException
SystemException
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<Portlet> getScopablePortlets()
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
PortletCategory getWARDisplay(String servletContextName,
String xml)
throws SystemException
SystemException
@Skip
@Transactional(propagation=SUPPORTS,
readOnly=true)
boolean hasPortlet(long companyId,
String portletId)
throws SystemException
SystemException
@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> loadGetPortletsPool(long companyId)
throws SystemException
SystemException@Clusterable @Transactional(enabled=false) void removeCompanyPortletsPool(long companyId)
Portlet updatePortlet(long companyId,
String portletId,
String roles,
boolean active)
throws SystemException
SystemException
|
Liferay 6.2.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||