com.liferay.commerce.product.service

Class CommerceChannelLocalServiceUtil

java.lang.Object

com.liferay.commerce.product.service.CommerceChannelLocalServiceUtil

public class CommerceChannelLocalServiceUtil
extends java.lang.Object

Provides the local service utility for CommerceChannel. This utility wraps com.liferay.commerce.product.service.impl.CommerceChannelLocalServiceImpl 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:

CommerceChannelLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
CommerceChannelLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CommerceChannel	addCommerceChannel(CommerceChannel commerceChannel) Adds the commerce channel to the database.
static CommerceChannel	addCommerceChannel(java.lang.String externalReferenceCode, long siteGroupId, java.lang.String name, java.lang.String type, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties, java.lang.String commerceCurrencyCode, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceChannel	addOrUpdateCommerceChannel(long userId, java.lang.String externalReferenceCode, long siteGroupId, java.lang.String name, java.lang.String type, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties, java.lang.String commerceCurrencyCode, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceChannel	createCommerceChannel(long commerceChannelId) Creates a new commerce channel with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static CommerceChannel	deleteCommerceChannel(CommerceChannel commerceChannel) Deletes the commerce channel from the database.
static CommerceChannel	deleteCommerceChannel(long commerceChannelId) Deletes the commerce channel with the primary key from the database.
static void	deleteCommerceChannels(long companyId)
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
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 CommerceChannel	fetchByExternalReferenceCode(java.lang.String externalReferenceCode, long companyId)
static CommerceChannel	fetchCommerceChannel(long commerceChannelId)
static CommerceChannel	fetchCommerceChannelByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the commerce channel with the matching external reference code and company.
static CommerceChannel	fetchCommerceChannelByReferenceCode(long companyId, java.lang.String externalReferenceCode) Deprecated. As of Cavanaugh (7.4.x), replaced by fetchCommerceChannelByExternalReferenceCode(long, String)
static CommerceChannel	fetchCommerceChannelBySiteGroupId(long siteGroupId)
static com.liferay.portal.kernel.model.Group	fetchCommerceChannelGroup(long commerceChannelId)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static CommerceChannel	getCommerceChannel(long commerceChannelId) Returns the commerce channel with the primary key.
static CommerceChannel	getCommerceChannelByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the commerce channel with the matching external reference code and company.
static CommerceChannel	getCommerceChannelByGroupId(long groupId)
static CommerceChannel	getCommerceChannelByOrderGroupId(long orderGroupId)
static com.liferay.portal.kernel.model.Group	getCommerceChannelGroup(long commerceChannelId)
static long	getCommerceChannelGroupIdBySiteGroupId(long siteGroupId)
static java.util.List<CommerceChannel>	getCommerceChannels(int start, int end) Returns a range of all the commerce channels.
static java.util.List<CommerceChannel>	getCommerceChannels(long companyId)
static int	getCommerceChannelsCount() Returns the number of commerce channels.
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 CommerceChannelLocalService	getService()
static java.util.List<CommerceChannel>	search(long companyId)
static java.util.List<CommerceChannel>	search(long companyId, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
static int	searchCommerceChannelsCount(long companyId, java.lang.String keywords)
static CommerceChannel	updateCommerceChannel(CommerceChannel commerceChannel) Updates the commerce channel in the database or adds it if it does not yet exist.
static CommerceChannel	updateCommerceChannel(long commerceChannelId, long siteGroupId, java.lang.String name, java.lang.String type, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties, java.lang.String commerceCurrencyCode)
static CommerceChannel	updateCommerceChannel(long commerceChannelId, long siteGroupId, java.lang.String name, java.lang.String type, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties, java.lang.String commerceCurrencyCode, java.lang.String priceDisplayType, boolean discountsTargetNetPrice)
static CommerceChannel	updateCommerceChannelExternalReferenceCode(java.lang.String externalReferenceCode, long commerceChannelId)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommerceChannelLocalServiceUtil

public CommerceChannelLocalServiceUtil()

Method Detail

addCommerceChannel

public static CommerceChannel addCommerceChannel(CommerceChannel commerceChannel)

Adds the commerce channel to the database. Also notifies the appropriate model listeners.

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

commerceChannel - the commerce channel

Returns:

the commerce channel that was added

addCommerceChannel

public static CommerceChannel addCommerceChannel(java.lang.String externalReferenceCode,
                                                 long siteGroupId,
                                                 java.lang.String name,
                                                 java.lang.String type,
                                                 com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties,
                                                 java.lang.String commerceCurrencyCode,
                                                 com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addOrUpdateCommerceChannel

public static CommerceChannel addOrUpdateCommerceChannel(long userId,
                                                         java.lang.String externalReferenceCode,
                                                         long siteGroupId,
                                                         java.lang.String name,
                                                         java.lang.String type,
                                                         com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties,
                                                         java.lang.String commerceCurrencyCode,
                                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceChannel

public static CommerceChannel createCommerceChannel(long commerceChannelId)

Creates a new commerce channel with the primary key. Does not add the commerce channel to the database.

Parameters:

commerceChannelId - the primary key for the new commerce channel

Returns:

the new commerce channel

createPersistedModel

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceChannel

public static CommerceChannel deleteCommerceChannel(CommerceChannel commerceChannel)
                                             throws com.liferay.portal.kernel.exception.PortalException

Deletes the commerce channel from the database. Also notifies the appropriate model listeners.

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

commerceChannel - the commerce channel

Returns:

the commerce channel that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceChannel

public static CommerceChannel deleteCommerceChannel(long commerceChannelId)
                                             throws com.liferay.portal.kernel.exception.PortalException

Deletes the commerce channel with the primary key from the database. Also notifies the appropriate model listeners.

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

commerceChannelId - the primary key of the commerce channel

Returns:

the commerce channel that was removed

Throws:

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

deleteCommerceChannels

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

Throws:

com.liferay.portal.kernel.exception.PortalException

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

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

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.commerce.product.model.impl.CommerceChannelModelImpl.

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.commerce.product.model.impl.CommerceChannelModelImpl.

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

fetchByExternalReferenceCode

public static CommerceChannel fetchByExternalReferenceCode(java.lang.String externalReferenceCode,
                                                           long companyId)

fetchCommerceChannel

public static CommerceChannel fetchCommerceChannel(long commerceChannelId)

fetchCommerceChannelByExternalReferenceCode

public static CommerceChannel fetchCommerceChannelByExternalReferenceCode(long companyId,
                                                                          java.lang.String externalReferenceCode)

Returns the commerce channel with the matching external reference code and company.

Parameters:

companyId - the primary key of the company

externalReferenceCode - the commerce channel's external reference code

Returns:

the matching commerce channel, or null if a matching commerce channel could not be found

fetchCommerceChannelByReferenceCode

@Deprecated
public static CommerceChannel fetchCommerceChannelByReferenceCode(long companyId,
                                                                              java.lang.String externalReferenceCode)

Deprecated. As of Cavanaugh (7.4.x), replaced by fetchCommerceChannelByExternalReferenceCode(long, String)

fetchCommerceChannelBySiteGroupId

public static CommerceChannel fetchCommerceChannelBySiteGroupId(long siteGroupId)

fetchCommerceChannelGroup

public static com.liferay.portal.kernel.model.Group fetchCommerceChannelGroup(long commerceChannelId)
                                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getActionableDynamicQuery

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

getCommerceChannel

public static CommerceChannel getCommerceChannel(long commerceChannelId)
                                          throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce channel with the primary key.

Parameters:

commerceChannelId - the primary key of the commerce channel

Returns:

the commerce channel

Throws:

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

getCommerceChannelByExternalReferenceCode

public static CommerceChannel getCommerceChannelByExternalReferenceCode(long companyId,
                                                                        java.lang.String externalReferenceCode)
                                                                 throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce channel with the matching external reference code and company.

Parameters:

companyId - the primary key of the company

externalReferenceCode - the commerce channel's external reference code

Returns:

the matching commerce channel

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching commerce channel could not be found

getCommerceChannelByGroupId

public static CommerceChannel getCommerceChannelByGroupId(long groupId)
                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceChannelByOrderGroupId

public static CommerceChannel getCommerceChannelByOrderGroupId(long orderGroupId)
                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceChannelGroup

public static com.liferay.portal.kernel.model.Group getCommerceChannelGroup(long commerceChannelId)
                                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceChannelGroupIdBySiteGroupId

public static long getCommerceChannelGroupIdBySiteGroupId(long siteGroupId)
                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceChannels

public static java.util.List<CommerceChannel> getCommerceChannels(int start,
                                                                  int end)

Returns a range of all the commerce channels.

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.commerce.product.model.impl.CommerceChannelModelImpl.

Parameters:

start - the lower bound of the range of commerce channels

end - the upper bound of the range of commerce channels (not inclusive)

Returns:

the range of commerce channels

getCommerceChannels

public static java.util.List<CommerceChannel> getCommerceChannels(long companyId)

getCommerceChannelsCount

public static int getCommerceChannelsCount()

Returns the number of commerce channels.

Returns:

the number of commerce channels

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

search

public static java.util.List<CommerceChannel> search(long companyId)
                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

search

public static java.util.List<CommerceChannel> search(long companyId,
                                                     java.lang.String keywords,
                                                     int start,
                                                     int end,
                                                     com.liferay.portal.kernel.search.Sort sort)
                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

searchCommerceChannelsCount

public static int searchCommerceChannelsCount(long companyId,
                                              java.lang.String keywords)
                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceChannel

public static CommerceChannel updateCommerceChannel(CommerceChannel commerceChannel)

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

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

commerceChannel - the commerce channel

Returns:

the commerce channel that was updated

updateCommerceChannel

public static CommerceChannel updateCommerceChannel(long commerceChannelId,
                                                    long siteGroupId,
                                                    java.lang.String name,
                                                    java.lang.String type,
                                                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties,
                                                    java.lang.String commerceCurrencyCode)
                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceChannel

public static CommerceChannel updateCommerceChannel(long commerceChannelId,
                                                    long siteGroupId,
                                                    java.lang.String name,
                                                    java.lang.String type,
                                                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties,
                                                    java.lang.String commerceCurrencyCode,
                                                    java.lang.String priceDisplayType,
                                                    boolean discountsTargetNetPrice)
                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceChannelExternalReferenceCode

public static CommerceChannel updateCommerceChannelExternalReferenceCode(java.lang.String externalReferenceCode,
                                                                         long commerceChannelId)
                                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CommerceChannelLocalService getService()