com.liferay.wsrp.service

Interface WSRPConsumerLocalService

All Superinterfaces:

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

All Known Implementing Classes:

WSRPConsumerLocalServiceWrapper

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

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

WSRPConsumerLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
WSRPConsumer	addWSRPConsumer(long companyId, java.lang.String adminPortletId, java.lang.String name, java.lang.String url, java.lang.String forwardCookies, java.lang.String forwardHeaders, java.lang.String markupCharacterSets, com.liferay.portal.kernel.service.ServiceContext serviceContext)
WSRPConsumer	addWSRPConsumer(WSRPConsumer wsrpConsumer) Adds the wsrp consumer to the database.
WSRPConsumer	createWSRPConsumer(long wsrpConsumerId) Creates a new wsrp consumer with the primary key.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
WSRPConsumer	deleteWSRPConsumer(long wsrpConsumerId) Deletes the wsrp consumer with the primary key from the database.
WSRPConsumer	deleteWSRPConsumer(WSRPConsumer wsrpConsumer) Deletes the wsrp consumer from the database.
void	deleteWSRPConsumers(long companyId)
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.
WSRPConsumer	fetchWSRPConsumer(long wsrpConsumerId)
WSRPConsumer	fetchWSRPConsumerByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the wsrp consumer 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)
WSRPConsumer	getWSRPConsumer(long wsrpConsumerId) Returns the wsrp consumer with the primary key.
WSRPConsumer	getWSRPConsumer(java.lang.String wsrpConsumerUuid)
WSRPConsumer	getWSRPConsumerByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the wsrp consumer with the matching UUID and company.
java.util.List<WSRPConsumer>	getWSRPConsumers(int start, int end) Returns a range of all the wsrp consumers.
java.util.List<WSRPConsumer>	getWSRPConsumers(long companyId, int start, int end)
int	getWSRPConsumersCount() Returns the number of wsrp consumers.
int	getWSRPConsumersCount(long companyId)
WSRPConsumer	registerWSRPConsumer(long wsrpConsumerId, java.lang.String adminPortletId, com.liferay.portal.kernel.util.UnicodeProperties registrationProperties, java.lang.String registrationHandle)
void	restartConsumer(long wsrpConsumerId)
void	updateServiceDescription(long wsrpConsumerId)
WSRPConsumer	updateWSRPConsumer(long wsrpConsumerId, java.lang.String adminPortletId, java.lang.String name, java.lang.String url, java.lang.String forwardCookies, java.lang.String forwardHeaders, java.lang.String markupCharacterSets)
WSRPConsumer	updateWSRPConsumer(WSRPConsumer wsrpConsumer) Updates the wsrp consumer in the database or adds it if it does not yet exist.

Method Detail

addWSRPConsumer

WSRPConsumer addWSRPConsumer(long companyId,
                             java.lang.String adminPortletId,
                             java.lang.String name,
                             java.lang.String url,
                             java.lang.String forwardCookies,
                             java.lang.String forwardHeaders,
                             java.lang.String markupCharacterSets,
                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addWSRPConsumer

@Indexable(type=REINDEX)
WSRPConsumer addWSRPConsumer(WSRPConsumer wsrpConsumer)

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

Important: Inspect WSRPConsumerLocalServiceImpl 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:

wsrpConsumer - the wsrp consumer

Returns:

the wsrp consumer that was added

createWSRPConsumer

@Transactional(enabled=false)
WSRPConsumer createWSRPConsumer(long wsrpConsumerId)

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

Parameters:

wsrpConsumerId - the primary key for the new wsrp consumer

Returns:

the new wsrp consumer

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

deleteWSRPConsumer

@Indexable(type=DELETE)
WSRPConsumer deleteWSRPConsumer(long wsrpConsumerId)
                                                 throws com.liferay.portal.kernel.exception.PortalException

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

Important: Inspect WSRPConsumerLocalServiceImpl 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:

wsrpConsumerId - the primary key of the wsrp consumer

Returns:

the wsrp consumer that was removed

Throws:

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

deleteWSRPConsumer

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
WSRPConsumer deleteWSRPConsumer(WSRPConsumer wsrpConsumer)
                                                                                              throws com.liferay.portal.kernel.exception.PortalException

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

Important: Inspect WSRPConsumerLocalServiceImpl 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:

wsrpConsumer - the wsrp consumer

Returns:

the wsrp consumer that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteWSRPConsumers

void deleteWSRPConsumers(long companyId)
                  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.WSRPConsumerModelImpl.

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

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

fetchWSRPConsumer

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WSRPConsumer fetchWSRPConsumer(long wsrpConsumerId)

fetchWSRPConsumerByUuidAndCompanyId

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

Returns the wsrp consumer with the matching UUID and company.

Parameters:

uuid - the wsrp consumer's UUID

companyId - the primary key of the company

Returns:

the matching wsrp consumer, or null if a matching wsrp consumer 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

getWSRPConsumer

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WSRPConsumer getWSRPConsumer(long wsrpConsumerId)
                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Returns the wsrp consumer with the primary key.

Parameters:

wsrpConsumerId - the primary key of the wsrp consumer

Returns:

the wsrp consumer

Throws:

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

getWSRPConsumer

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WSRPConsumer getWSRPConsumer(java.lang.String wsrpConsumerUuid)
                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getWSRPConsumerByUuidAndCompanyId

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

Returns the wsrp consumer with the matching UUID and company.

Parameters:

uuid - the wsrp consumer's UUID

companyId - the primary key of the company

Returns:

the matching wsrp consumer

Throws:

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

getWSRPConsumers

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

Returns a range of all the wsrp consumers.

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

Parameters:

start - the lower bound of the range of wsrp consumers

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

Returns:

the range of wsrp consumers

getWSRPConsumers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WSRPConsumer> getWSRPConsumers(long companyId,
                                                                                                                 int start,
                                                                                                                 int end)

getWSRPConsumersCount

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

Returns the number of wsrp consumers.

Returns:

the number of wsrp consumers

getWSRPConsumersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWSRPConsumersCount(long companyId)

registerWSRPConsumer

WSRPConsumer registerWSRPConsumer(long wsrpConsumerId,
                                  java.lang.String adminPortletId,
                                  com.liferay.portal.kernel.util.UnicodeProperties registrationProperties,
                                  java.lang.String registrationHandle)
                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

restartConsumer

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void restartConsumer(long wsrpConsumerId)
                                                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateServiceDescription

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

Throws:

com.liferay.portal.kernel.exception.PortalException

updateWSRPConsumer

WSRPConsumer updateWSRPConsumer(long wsrpConsumerId,
                                java.lang.String adminPortletId,
                                java.lang.String name,
                                java.lang.String url,
                                java.lang.String forwardCookies,
                                java.lang.String forwardHeaders,
                                java.lang.String markupCharacterSets)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateWSRPConsumer

@Indexable(type=REINDEX)
WSRPConsumer updateWSRPConsumer(WSRPConsumer wsrpConsumer)

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

Important: Inspect WSRPConsumerLocalServiceImpl 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:

wsrpConsumer - the wsrp consumer

Returns:

the wsrp consumer that was updated