com.liferay.wsrp.service

Interface WSRPConsumerPortletLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

WSRPConsumerPortletLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface WSRPConsumerPortletLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for WSRPConsumerPortlet. 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:

WSRPConsumerPortletLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
WSRPConsumerPortlet	addWSRPConsumerPortlet(long wsrpConsumerId, java.lang.String name, java.lang.String portletHandle, com.liferay.portal.kernel.service.ServiceContext serviceContext)
WSRPConsumerPortlet	addWSRPConsumerPortlet(java.lang.String wsrpConsumerUuid, java.lang.String name, java.lang.String portletHandle, com.liferay.portal.kernel.service.ServiceContext serviceContext)
WSRPConsumerPortlet	addWSRPConsumerPortlet(WSRPConsumerPortlet wsrpConsumerPortlet) Adds the wsrp consumer portlet to the database.
WSRPConsumerPortlet	createWSRPConsumerPortlet(long wsrpConsumerPortletId) Creates a new wsrp consumer portlet with the primary key.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
WSRPConsumerPortlet	deleteWSRPConsumerPortlet(long wsrpConsumerPortletId) Deletes the wsrp consumer portlet with the primary key from the database.
void	deleteWSRPConsumerPortlet(java.lang.String wsrpConsumerPortletUuid)
WSRPConsumerPortlet	deleteWSRPConsumerPortlet(WSRPConsumerPortlet wsrpConsumerPortlet) Deletes the wsrp consumer portlet from the database.
void	deleteWSRPConsumerPortlets(long wsrpConsumerId)
void	destroyWSRPConsumerPortlet(long wsrpConsumerPortletId, java.lang.String wsrpConsumerPortletUuid, java.lang.String url)
void	destroyWSRPConsumerPortlets()
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
WSRPConsumerPortlet	fetchWSRPConsumerPortlet(long wsrpConsumerPortletId)
WSRPConsumerPortlet	fetchWSRPConsumerPortletByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the wsrp consumer portlet with the matching UUID and company.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
WSRPConsumerPortlet	getWSRPConsumerPortlet(long wsrpConsumerPortletId) Returns the wsrp consumer portlet with the primary key.
WSRPConsumerPortlet	getWSRPConsumerPortlet(long wsrpConsumerId, java.lang.String portletHandle)
WSRPConsumerPortlet	getWSRPConsumerPortlet(java.lang.String wsrpConsumerPortletUuid)
WSRPConsumerPortlet	getWSRPConsumerPortletByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the wsrp consumer portlet with the matching UUID and company.
java.util.List<WSRPConsumerPortlet>	getWSRPConsumerPortlets(int start, int end) Returns a range of all the wsrp consumer portlets.
java.util.List<WSRPConsumerPortlet>	getWSRPConsumerPortlets(long wsrpConsumerId, int start, int end)
int	getWSRPConsumerPortletsCount() Returns the number of wsrp consumer portlets.
int	getWSRPConsumerPortletsCount(long wsrpConsumerId)
void	initFailedWSRPConsumerPortlets()
void	initWSRPConsumerPortlet(long companyId, long wsrpConsumerId, long wsrpConsumerPortletId, java.lang.String wsrpConsumerPortletUuid, java.lang.String name, java.lang.String portletHandle)
void	initWSRPConsumerPortlets()
WSRPConsumerPortlet	updateWSRPConsumerPortlet(long wsrpConsumerPortletId, java.lang.String name)
WSRPConsumerPortlet	updateWSRPConsumerPortlet(WSRPConsumerPortlet wsrpConsumerPortlet) Updates the wsrp consumer portlet in the database or adds it if it does not yet exist.

Method Detail

addWSRPConsumerPortlet

WSRPConsumerPortlet addWSRPConsumerPortlet(long wsrpConsumerId,
                                           java.lang.String name,
                                           java.lang.String portletHandle,
                                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addWSRPConsumerPortlet

WSRPConsumerPortlet addWSRPConsumerPortlet(java.lang.String wsrpConsumerUuid,
                                           java.lang.String name,
                                           java.lang.String portletHandle,
                                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addWSRPConsumerPortlet

@Indexable(type=REINDEX)
WSRPConsumerPortlet addWSRPConsumerPortlet(WSRPConsumerPortlet wsrpConsumerPortlet)

Adds the wsrp consumer portlet to the database. Also notifies the appropriate model listeners.

Important: Inspect WSRPConsumerPortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

wsrpConsumerPortlet - the wsrp consumer portlet

Returns:

the wsrp consumer portlet that was added

createWSRPConsumerPortlet

@Transactional(enabled=false)
WSRPConsumerPortlet createWSRPConsumerPortlet(long wsrpConsumerPortletId)

Creates a new wsrp consumer portlet with the primary key. Does not add the wsrp consumer portlet to the database.

Parameters:

wsrpConsumerPortletId - the primary key for the new wsrp consumer portlet

Returns:

the new wsrp consumer portlet

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteWSRPConsumerPortlet

@Indexable(type=DELETE)
WSRPConsumerPortlet deleteWSRPConsumerPortlet(long wsrpConsumerPortletId)
                                                               throws com.liferay.portal.kernel.exception.PortalException

Deletes the wsrp consumer portlet with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect WSRPConsumerPortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

wsrpConsumerPortletId - the primary key of the wsrp consumer portlet

Returns:

the wsrp consumer portlet that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a wsrp consumer portlet with the primary key could not be found

deleteWSRPConsumerPortlet

void deleteWSRPConsumerPortlet(java.lang.String wsrpConsumerPortletUuid)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteWSRPConsumerPortlet

@Indexable(type=DELETE)
 @SystemEvent(type=1)
WSRPConsumerPortlet deleteWSRPConsumerPortlet(WSRPConsumerPortlet wsrpConsumerPortlet)
                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Deletes the wsrp consumer portlet from the database. Also notifies the appropriate model listeners.

Important: Inspect WSRPConsumerPortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

wsrpConsumerPortlet - the wsrp consumer portlet

Returns:

the wsrp consumer portlet that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteWSRPConsumerPortlets

void deleteWSRPConsumerPortlets(long wsrpConsumerId)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

destroyWSRPConsumerPortlet

@Clusterable
void destroyWSRPConsumerPortlet(long wsrpConsumerPortletId,
                                             java.lang.String wsrpConsumerPortletUuid,
                                             java.lang.String url)

destroyWSRPConsumerPortlets

void destroyWSRPConsumerPortlets()
                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end)

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.wsrp.model.impl.WSRPConsumerPortletModelImpl.

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.wsrp.model.impl.WSRPConsumerPortletModelImpl.

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

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                          com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchWSRPConsumerPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WSRPConsumerPortlet fetchWSRPConsumerPortlet(long wsrpConsumerPortletId)

fetchWSRPConsumerPortletByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WSRPConsumerPortlet fetchWSRPConsumerPortletByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                  long companyId)

Returns the wsrp consumer portlet with the matching UUID and company.

Parameters:

uuid - the wsrp consumer portlet's UUID

companyId - the primary key of the company

Returns:

the matching wsrp consumer portlet, or null if a matching wsrp consumer portlet could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getWSRPConsumerPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WSRPConsumerPortlet getWSRPConsumerPortlet(long wsrpConsumerPortletId)
                                                                                                       throws com.liferay.portal.kernel.exception.PortalException

Returns the wsrp consumer portlet with the primary key.

Parameters:

wsrpConsumerPortletId - the primary key of the wsrp consumer portlet

Returns:

the wsrp consumer portlet

Throws:

com.liferay.portal.kernel.exception.PortalException - if a wsrp consumer portlet with the primary key could not be found

getWSRPConsumerPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WSRPConsumerPortlet getWSRPConsumerPortlet(long wsrpConsumerId,
                                                                                                              java.lang.String portletHandle)
                                                                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getWSRPConsumerPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WSRPConsumerPortlet getWSRPConsumerPortlet(java.lang.String wsrpConsumerPortletUuid)
                                                                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getWSRPConsumerPortletByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WSRPConsumerPortlet getWSRPConsumerPortletByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                long companyId)
                                                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Returns the wsrp consumer portlet with the matching UUID and company.

Parameters:

uuid - the wsrp consumer portlet's UUID

companyId - the primary key of the company

Returns:

the matching wsrp consumer portlet

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching wsrp consumer portlet could not be found

getWSRPConsumerPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WSRPConsumerPortlet> getWSRPConsumerPortlets(int start,
                                                                                                                               int end)

Returns a range of all the wsrp consumer 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.wsrp.model.impl.WSRPConsumerPortletModelImpl.

Parameters:

start - the lower bound of the range of wsrp consumer portlets

end - the upper bound of the range of wsrp consumer portlets (not inclusive)

Returns:

the range of wsrp consumer portlets

getWSRPConsumerPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WSRPConsumerPortlet> getWSRPConsumerPortlets(long wsrpConsumerId,
                                                                                                                               int start,
                                                                                                                               int end)

getWSRPConsumerPortletsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWSRPConsumerPortletsCount()

Returns the number of wsrp consumer portlets.

Returns:

the number of wsrp consumer portlets

getWSRPConsumerPortletsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWSRPConsumerPortletsCount(long wsrpConsumerId)

initFailedWSRPConsumerPortlets

@Clusterable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
void initFailedWSRPConsumerPortlets()

initWSRPConsumerPortlet

@Clusterable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
void initWSRPConsumerPortlet(long companyId,
                                                                                                              long wsrpConsumerId,
                                                                                                              long wsrpConsumerPortletId,
                                                                                                              java.lang.String wsrpConsumerPortletUuid,
                                                                                                              java.lang.String name,
                                                                                                              java.lang.String portletHandle)
                                                                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

initWSRPConsumerPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void initWSRPConsumerPortlets()

updateWSRPConsumerPortlet

WSRPConsumerPortlet updateWSRPConsumerPortlet(long wsrpConsumerPortletId,
                                              java.lang.String name)
                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateWSRPConsumerPortlet

@Indexable(type=REINDEX)
WSRPConsumerPortlet updateWSRPConsumerPortlet(WSRPConsumerPortlet wsrpConsumerPortlet)

Updates the wsrp consumer portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect WSRPConsumerPortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

wsrpConsumerPortlet - the wsrp consumer portlet

Returns:

the wsrp consumer portlet that was updated