com.liferay.wsrp.service

Class WSRPConsumerLocalServiceUtil

java.lang.Object

com.liferay.wsrp.service.WSRPConsumerLocalServiceUtil

public class WSRPConsumerLocalServiceUtil
extends java.lang.Object

Provides the local service utility for WSRPConsumer. This utility wraps com.liferay.wsrp.service.impl.WSRPConsumerLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:

WSRPConsumerLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
WSRPConsumerLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static 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)
static WSRPConsumer	addWSRPConsumer(WSRPConsumer wsrpConsumer) Adds the wsrp consumer to the database.
static WSRPConsumer	createWSRPConsumer(long wsrpConsumerId) Creates a new wsrp consumer with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static WSRPConsumer	deleteWSRPConsumer(long wsrpConsumerId) Deletes the wsrp consumer with the primary key from the database.
static WSRPConsumer	deleteWSRPConsumer(WSRPConsumer wsrpConsumer) Deletes the wsrp consumer from the database.
static void	deleteWSRPConsumers(long companyId)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <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.
static <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.
static <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.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static 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.
static WSRPConsumer	fetchWSRPConsumer(long wsrpConsumerId)
static WSRPConsumer	fetchWSRPConsumerByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the wsrp consumer with the matching UUID and company.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static WSRPConsumerLocalService	getService()
static WSRPConsumer	getWSRPConsumer(long wsrpConsumerId) Returns the wsrp consumer with the primary key.
static WSRPConsumer	getWSRPConsumer(java.lang.String wsrpConsumerUuid)
static WSRPConsumer	getWSRPConsumerByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the wsrp consumer with the matching UUID and company.
static java.util.List<WSRPConsumer>	getWSRPConsumers(int start, int end) Returns a range of all the wsrp consumers.
static java.util.List<WSRPConsumer>	getWSRPConsumers(long companyId, int start, int end)
static int	getWSRPConsumersCount() Returns the number of wsrp consumers.
static int	getWSRPConsumersCount(long companyId)
static WSRPConsumer	registerWSRPConsumer(long wsrpConsumerId, java.lang.String adminPortletId, com.liferay.portal.kernel.util.UnicodeProperties registrationProperties, java.lang.String registrationHandle)
static void	restartConsumer(long wsrpConsumerId)
static void	updateServiceDescription(long wsrpConsumerId)
static 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)
static WSRPConsumer	updateWSRPConsumer(WSRPConsumer wsrpConsumer) Updates the wsrp consumer in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WSRPConsumerLocalServiceUtil

public WSRPConsumerLocalServiceUtil()

Method Detail

addWSRPConsumer

public static 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

public static 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

public static 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

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteWSRPConsumer

public static 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

public static 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

public static void deleteWSRPConsumers(long companyId)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public static <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

public static <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

public static 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

public static 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

public static WSRPConsumer fetchWSRPConsumer(long wsrpConsumerId)

fetchWSRPConsumerByUuidAndCompanyId

public static 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

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getWSRPConsumer

public static 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

public static WSRPConsumer getWSRPConsumer(java.lang.String wsrpConsumerUuid)
                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getWSRPConsumerByUuidAndCompanyId

public static 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

public static 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

public static java.util.List<WSRPConsumer> getWSRPConsumers(long companyId,
                                                            int start,
                                                            int end)

getWSRPConsumersCount

public static int getWSRPConsumersCount()

Returns the number of wsrp consumers.

Returns:

the number of wsrp consumers

getWSRPConsumersCount

public static int getWSRPConsumersCount(long companyId)

registerWSRPConsumer

public static 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

public static void restartConsumer(long wsrpConsumerId)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateServiceDescription

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

Throws:

com.liferay.portal.kernel.exception.PortalException

updateWSRPConsumer

public static 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

public static 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

getService

public static WSRPConsumerLocalService getService()