@ProviderType
public class WSRPConsumerLocalServiceUtil
extends java.lang.Object
com.liferay.wsrp.service.impl.WSRPConsumerLocalServiceImpl
and is the
primary 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.WSRPConsumerLocalService
,
com.liferay.wsrp.service.base.WSRPConsumerLocalServiceBaseImpl
,
com.liferay.wsrp.service.impl.WSRPConsumerLocalServiceImpl
Constructor and Description |
---|
WSRPConsumerLocalServiceUtil() |
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.
|
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
com.liferay.portal.kernel.exception.PortalException
public static WSRPConsumer addWSRPConsumer(WSRPConsumer wsrpConsumer)
wsrpConsumer
- the wsrp consumerpublic static WSRPConsumer createWSRPConsumer(long wsrpConsumerId)
wsrpConsumerId
- the primary key for the new wsrp consumerpublic static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
PortalException
public static WSRPConsumer deleteWSRPConsumer(long wsrpConsumerId) throws com.liferay.portal.kernel.exception.PortalException
wsrpConsumerId
- the primary key of the wsrp consumerPortalException
- if a wsrp consumer with the primary key could not be foundpublic static WSRPConsumer deleteWSRPConsumer(WSRPConsumer wsrpConsumer) throws com.liferay.portal.kernel.exception.PortalException
wsrpConsumer
- the wsrp consumerPortalException
public static void deleteWSRPConsumers(long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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 com.liferay.wsrp.model.impl.WSRPConsumerModelImpl
. 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)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)
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 com.liferay.wsrp.model.impl.WSRPConsumerModelImpl
. 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
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static WSRPConsumer fetchWSRPConsumer(long wsrpConsumerId)
public static WSRPConsumer fetchWSRPConsumerByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the wsrp consumer's UUIDcompanyId
- the primary key of the companynull
if a matching wsrp consumer could not be foundpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static WSRPConsumer getWSRPConsumer(long wsrpConsumerId) throws com.liferay.portal.kernel.exception.PortalException
wsrpConsumerId
- the primary key of the wsrp consumerPortalException
- if a wsrp consumer with the primary key could not be foundpublic static WSRPConsumer getWSRPConsumer(java.lang.String wsrpConsumerUuid) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static WSRPConsumer getWSRPConsumerByUuidAndCompanyId(java.lang.String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the wsrp consumer's UUIDcompanyId
- the primary key of the companyPortalException
- if a matching wsrp consumer could not be foundpublic static java.util.List<WSRPConsumer> getWSRPConsumers(int start, int end)
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 com.liferay.wsrp.model.impl.WSRPConsumerModelImpl
. 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 wsrp consumersend
- the upper bound of the range of wsrp consumers (not inclusive)public static java.util.List<WSRPConsumer> getWSRPConsumers(long companyId, int start, int end)
public static int getWSRPConsumersCount()
public static int getWSRPConsumersCount(long companyId)
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
com.liferay.portal.kernel.exception.PortalException
public static void restartConsumer(long wsrpConsumerId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void updateServiceDescription(long wsrpConsumerId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
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
com.liferay.portal.kernel.exception.PortalException
public static WSRPConsumer updateWSRPConsumer(WSRPConsumer wsrpConsumer)
wsrpConsumer
- the wsrp consumerpublic static WSRPConsumerLocalService getService()