com.liferay.commerce.service

Class CommercePaymentMethodLocalServiceUtil

java.lang.Object

com.liferay.commerce.service.CommercePaymentMethodLocalServiceUtil

@ProviderType
public class CommercePaymentMethodLocalServiceUtil
extends java.lang.Object

Provides the local service utility for CommercePaymentMethod. This utility wraps com.liferay.commerce.service.impl.CommercePaymentMethodLocalServiceImpl 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.

See Also:

CommercePaymentMethodLocalService, com.liferay.commerce.service.base.CommercePaymentMethodLocalServiceBaseImpl, com.liferay.commerce.service.impl.CommercePaymentMethodLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
CommercePaymentMethodLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CommercePaymentMethod	addCommercePaymentMethod(CommercePaymentMethod commercePaymentMethod) Adds the commerce payment method to the database.
static CommercePaymentMethod	addCommercePaymentMethod(java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.io.File imageFile, java.lang.String engineKey, java.util.Map<java.lang.String,java.lang.String> engineParameterMap, double priority, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommercePaymentMethod	createCommercePaymentMethod(long commercePaymentMethodId) Creates a new commerce payment method with the primary key.
static CommercePaymentMethod	deleteCommercePaymentMethod(CommercePaymentMethod commercePaymentMethod) Deletes the commerce payment method from the database.
static CommercePaymentMethod	deleteCommercePaymentMethod(long commercePaymentMethodId) Deletes the commerce payment method with the primary key from the database.
static void	deleteCommercePaymentMethods(long groupId)
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
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 CommercePaymentMethod	fetchCommercePaymentMethod(long commercePaymentMethodId)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static CommercePaymentMethod	getCommercePaymentMethod(long commercePaymentMethodId) Returns the commerce payment method with the primary key.
static java.util.List<CommercePaymentMethod>	getCommercePaymentMethods(int start, int end) Returns a range of all the commerce payment methods.
static java.util.List<CommercePaymentMethod>	getCommercePaymentMethods(long groupId)
static java.util.List<CommercePaymentMethod>	getCommercePaymentMethods(long groupId, boolean active)
static java.util.List<CommercePaymentMethod>	getCommercePaymentMethods(long groupId, long commerceCountryId, boolean active)
static int	getCommercePaymentMethodsCount() Returns the number of commerce payment methods.
static int	getCommercePaymentMethodsCount(long groupId, boolean active)
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 CommercePaymentMethodLocalService	getService()
static CommercePaymentMethod	setActive(long commercePaymentMethodId, boolean active)
static CommercePaymentMethod	updateCommercePaymentMethod(CommercePaymentMethod commercePaymentMethod) Updates the commerce payment method in the database or adds it if it does not yet exist.
static CommercePaymentMethod	updateCommercePaymentMethod(long commercePaymentMethodId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.io.File imageFile, java.util.Map<java.lang.String,java.lang.String> engineParameterMap, double priority, boolean active, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommercePaymentMethodLocalServiceUtil

public CommercePaymentMethodLocalServiceUtil()

Method Detail

addCommercePaymentMethod

public static CommercePaymentMethod addCommercePaymentMethod(CommercePaymentMethod commercePaymentMethod)

Adds the commerce payment method to the database. Also notifies the appropriate model listeners.

Parameters:

commercePaymentMethod - the commerce payment method

Returns:

the commerce payment method that was added

addCommercePaymentMethod

public static CommercePaymentMethod addCommercePaymentMethod(java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                             java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                             java.io.File imageFile,
                                                             java.lang.String engineKey,
                                                             java.util.Map<java.lang.String,java.lang.String> engineParameterMap,
                                                             double priority,
                                                             boolean active,
                                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommercePaymentMethod

public static CommercePaymentMethod createCommercePaymentMethod(long commercePaymentMethodId)

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

Parameters:

commercePaymentMethodId - the primary key for the new commerce payment method

Returns:

the new commerce payment method

deleteCommercePaymentMethod

public static CommercePaymentMethod deleteCommercePaymentMethod(CommercePaymentMethod commercePaymentMethod)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Deletes the commerce payment method from the database. Also notifies the appropriate model listeners.

Parameters:

commercePaymentMethod - the commerce payment method

Returns:

the commerce payment method that was removed

Throws:

PortalException

deleteCommercePaymentMethod

public static CommercePaymentMethod deleteCommercePaymentMethod(long commercePaymentMethodId)
                                                         throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

commercePaymentMethodId - the primary key of the commerce payment method

Returns:

the commerce payment method that was removed

Throws:

PortalException - if a commerce payment method with the primary key could not be found

deleteCommercePaymentMethods

public static void deleteCommercePaymentMethods(long groupId)
                                         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:

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

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

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

fetchCommercePaymentMethod

public static CommercePaymentMethod fetchCommercePaymentMethod(long commercePaymentMethodId)

getActionableDynamicQuery

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

getCommercePaymentMethod

public static CommercePaymentMethod getCommercePaymentMethod(long commercePaymentMethodId)
                                                      throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce payment method with the primary key.

Parameters:

commercePaymentMethodId - the primary key of the commerce payment method

Returns:

the commerce payment method

Throws:

PortalException - if a commerce payment method with the primary key could not be found

getCommercePaymentMethods

public static java.util.List<CommercePaymentMethod> getCommercePaymentMethods(int start,
                                                                              int end)

Returns a range of all the commerce payment methods.

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

Parameters:

start - the lower bound of the range of commerce payment methods

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

Returns:

the range of commerce payment methods

getCommercePaymentMethods

public static java.util.List<CommercePaymentMethod> getCommercePaymentMethods(long groupId)

getCommercePaymentMethods

public static java.util.List<CommercePaymentMethod> getCommercePaymentMethods(long groupId,
                                                                              boolean active)

getCommercePaymentMethods

public static java.util.List<CommercePaymentMethod> getCommercePaymentMethods(long groupId,
                                                                              long commerceCountryId,
                                                                              boolean active)

getCommercePaymentMethodsCount

public static int getCommercePaymentMethodsCount()

Returns the number of commerce payment methods.

Returns:

the number of commerce payment methods

getCommercePaymentMethodsCount

public static int getCommercePaymentMethodsCount(long groupId,
                                                 boolean active)

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

setActive

public static CommercePaymentMethod setActive(long commercePaymentMethodId,
                                              boolean active)
                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommercePaymentMethod

public static CommercePaymentMethod updateCommercePaymentMethod(CommercePaymentMethod commercePaymentMethod)

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

Parameters:

commercePaymentMethod - the commerce payment method

Returns:

the commerce payment method that was updated

updateCommercePaymentMethod

public static CommercePaymentMethod updateCommercePaymentMethod(long commercePaymentMethodId,
                                                                java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                                java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                                java.io.File imageFile,
                                                                java.util.Map<java.lang.String,java.lang.String> engineParameterMap,
                                                                double priority,
                                                                boolean active,
                                                                com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CommercePaymentMethodLocalService getService()