|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface PortletLocalService
The interface for the portlet local service.
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.
PortletLocalServiceUtil
,
PortletLocalServiceBaseImpl
,
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()
|
Portlet |
clonePortlet(long companyId,
String portletId)
Deprecated. 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. |
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. |
Portlet |
updatePortlet(Portlet portlet,
boolean merge)
Updates the portlet in the database or adds it if it does not yet exist. |
Method Detail |
---|
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
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 occurredPortlet 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 occurredList 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 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 occurredList 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 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 occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic 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 PersistedModelLocalService
PortalException
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.
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 occurredPortlet updatePortlet(Portlet portlet) throws SystemException
portlet
- the portlet
SystemException
- if a system exception occurredPortlet updatePortlet(Portlet portlet, boolean merge) throws SystemException
portlet
- the portletmerge
- 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 occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanvoid addPortletCategory(long companyId, String categoryName)
void checkPortlet(Portlet portlet) throws PortalException, SystemException
PortalException
SystemException
void checkPortlets(long companyId) throws PortalException, SystemException
PortalException
SystemException
void clearCache()
void clearCompanyPortletsPool()
Portlet clonePortlet(long companyId, String portletId)
clonePortlet(String)
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
void destroyPortlet(Portlet portlet)
void destroyRemotePortlet(Portlet portlet)
@Transactional(propagation=SUPPORTS, readOnly=true) List<CustomAttributesDisplay> getCustomAttributesDisplays()
@Transactional(propagation=SUPPORTS, readOnly=true) PortletCategory getEARDisplay(String xml) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Portlet> getFriendlyURLMapperPortlets()
@Transactional(propagation=SUPPORTS, readOnly=true) List<FriendlyURLMapper> getFriendlyURLMappers()
@Transactional(propagation=SUPPORTS, readOnly=true) PortletApp getPortletApp(String servletContextName)
@Transactional(propagation=SUPPORTS, readOnly=true) Portlet getPortletById(long companyId, String portletId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) Portlet getPortletById(String portletId)
@Transactional(propagation=SUPPORTS, readOnly=true) Portlet getPortletByStrutsPath(long companyId, String strutsPath) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Portlet> getPortlets()
@Transactional(propagation=SUPPORTS, readOnly=true) List<Portlet> getPortlets(long companyId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Portlet> getPortlets(long companyId, boolean showSystem, boolean showPortal) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Portlet> getScopablePortlets()
@Transactional(propagation=SUPPORTS, readOnly=true) PortletCategory getWARDisplay(String servletContextName, String xml) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasPortlet(long companyId, String portletId) throws SystemException
SystemException
void initEAR(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage)
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
void removeCompanyPortletsPool(long companyId)
Portlet updatePortlet(long companyId, String portletId, String roles, boolean active) throws SystemException
SystemException
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |