com.liferay.commerce.service

Interface CommercePaymentMethodLocalService

All Superinterfaces:

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

All Known Implementing Classes:

CommercePaymentMethodLocalServiceWrapper

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

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

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

Generated:

Method Summary

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

Method Detail

addCommercePaymentMethod

@Indexable(type=REINDEX)
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

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

@Transactional(enabled=false)
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

@Indexable(type=DELETE)
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:

com.liferay.portal.kernel.exception.PortalException

deleteCommercePaymentMethod

@Indexable(type=DELETE)
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:

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

deleteCommercePaymentMethods

void deleteCommercePaymentMethods(long groupId)
                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

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

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery 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.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

<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

<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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommercePaymentMethod fetchCommercePaymentMethod(long commercePaymentMethodId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCommercePaymentMethod

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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:

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

getCommercePaymentMethods

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommercePaymentMethod> getCommercePaymentMethods(long groupId)

getCommercePaymentMethods

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommercePaymentMethod> getCommercePaymentMethods(long groupId,
                                                                                                                                   boolean active)

getCommercePaymentMethods

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommercePaymentMethod> getCommercePaymentMethods(long groupId,
                                                                                                                                   long commerceCountryId,
                                                                                                                                   boolean active)

getCommercePaymentMethodsCount

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

Returns the number of commerce payment methods.

Returns:

the number of commerce payment methods

getCommercePaymentMethodsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommercePaymentMethodsCount(long groupId,
                                                                                                      boolean active)

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

setActive

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

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommercePaymentMethod

@Indexable(type=REINDEX)
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

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