com.liferay.commerce.service

Interface CommerceShippingMethodLocalService

All Superinterfaces:

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

All Known Implementing Classes:

CommerceShippingMethodLocalServiceWrapper

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

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

CommerceShippingMethodLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
CommerceAddressRestriction	addCommerceAddressRestriction(long userId, long groupId, long commerceShippingMethodId, long countryId)
CommerceAddressRestriction	addCommerceAddressRestriction(long commerceShippingMethodId, long countryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of Athanasius (7.3.x)
CommerceShippingMethod	addCommerceShippingMethod(CommerceShippingMethod commerceShippingMethod) Adds the commerce shipping method to the database.
CommerceShippingMethod	addCommerceShippingMethod(long userId, long groupId, 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, double priority, boolean active)
CommerceShippingMethod	createCommerceShippingMethod(long commerceShippingMethodId) Creates a new commerce shipping method with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
void	deleteCommerceAddressRestriction(long commerceAddressRestrictionId)
CommerceShippingMethod	deleteCommerceShippingMethod(CommerceShippingMethod commerceShippingMethod) Deletes the commerce shipping method from the database.
CommerceShippingMethod	deleteCommerceShippingMethod(long commerceShippingMethodId) Deletes the commerce shipping method with the primary key from the database.
void	deleteCommerceShippingMethods(long groupId)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
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.
CommerceShippingMethod	fetchCommerceShippingMethod(long commerceShippingMethodId)
CommerceShippingMethod	fetchCommerceShippingMethod(long groupId, java.lang.String engineKey)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
java.util.List<CommerceAddressRestriction>	getCommerceAddressRestrictions(long commerceShippingMethodId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceAddressRestriction> orderByComparator)
int	getCommerceAddressRestrictionsCount(long commerceShippingMethodId)
CommerceShippingMethod	getCommerceShippingMethod(long commerceShippingMethodId) Returns the commerce shipping method with the primary key.
java.util.List<CommerceShippingMethod>	getCommerceShippingMethods(int start, int end) Returns a range of all the commerce shipping methods.
java.util.List<CommerceShippingMethod>	getCommerceShippingMethods(long groupId)
java.util.List<CommerceShippingMethod>	getCommerceShippingMethods(long groupId, boolean active)
java.util.List<CommerceShippingMethod>	getCommerceShippingMethods(long groupId, long countryId, boolean active)
int	getCommerceShippingMethodsCount() Returns the number of commerce shipping methods.
int	getCommerceShippingMethodsCount(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)
CommerceShippingMethod	setActive(long commerceShippingMethodId, boolean active)
CommerceShippingMethod	updateCommerceShippingMethod(CommerceShippingMethod commerceShippingMethod) Updates the commerce shipping method in the database or adds it if it does not yet exist.
CommerceShippingMethod	updateCommerceShippingMethod(long commerceShippingMethodId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.io.File imageFile, double priority, boolean active)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addCommerceAddressRestriction

CommerceAddressRestriction addCommerceAddressRestriction(long userId,
                                                         long groupId,
                                                         long commerceShippingMethodId,
                                                         long countryId)
                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addCommerceAddressRestriction

@Deprecated
CommerceAddressRestriction addCommerceAddressRestriction(long commerceShippingMethodId,
                                                                     long countryId,
                                                                     com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                              throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Athanasius (7.3.x)

Throws:

com.liferay.portal.kernel.exception.PortalException

addCommerceShippingMethod

@Indexable(type=REINDEX)
CommerceShippingMethod addCommerceShippingMethod(CommerceShippingMethod commerceShippingMethod)

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

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

commerceShippingMethod - the commerce shipping method

Returns:

the commerce shipping method that was added

addCommerceShippingMethod

CommerceShippingMethod addCommerceShippingMethod(long userId,
                                                 long groupId,
                                                 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,
                                                 double priority,
                                                 boolean active)
                                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceShippingMethod

@Transactional(enabled=false)
CommerceShippingMethod createCommerceShippingMethod(long commerceShippingMethodId)

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

Parameters:

commerceShippingMethodId - the primary key for the new commerce shipping method

Returns:

the new commerce shipping method

createPersistedModel

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

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceAddressRestriction

void deleteCommerceAddressRestriction(long commerceAddressRestrictionId)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceShippingMethod

@Indexable(type=DELETE)
 @SystemEvent(type=1)
CommerceShippingMethod deleteCommerceShippingMethod(CommerceShippingMethod commerceShippingMethod)
                                                                                           throws com.liferay.portal.kernel.exception.PortalException

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

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

commerceShippingMethod - the commerce shipping method

Returns:

the commerce shipping method that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceShippingMethod

@Indexable(type=DELETE)
CommerceShippingMethod deleteCommerceShippingMethod(long commerceShippingMethodId)
                                                                     throws com.liferay.portal.kernel.exception.PortalException

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

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

commerceShippingMethodId - the primary key of the commerce shipping method

Returns:

the commerce shipping method that was removed

Throws:

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

deleteCommerceShippingMethods

void deleteCommerceShippingMethods(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

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dynamicQuery

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

dynamicQuery

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

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

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

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

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

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

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

fetchCommerceShippingMethod

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceShippingMethod fetchCommerceShippingMethod(long commerceShippingMethodId)

fetchCommerceShippingMethod

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceShippingMethod fetchCommerceShippingMethod(long groupId,
                                                                                                                      java.lang.String engineKey)

getActionableDynamicQuery

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

getCommerceAddressRestrictions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceAddressRestriction> getCommerceAddressRestrictions(long commerceShippingMethodId,
                                                                                                                                             int start,
                                                                                                                                             int end,
                                                                                                                                             com.liferay.portal.kernel.util.OrderByComparator<CommerceAddressRestriction> orderByComparator)

getCommerceAddressRestrictionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceAddressRestrictionsCount(long commerceShippingMethodId)

getCommerceShippingMethod

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceShippingMethod getCommerceShippingMethod(long commerceShippingMethodId)
                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce shipping method with the primary key.

Parameters:

commerceShippingMethodId - the primary key of the commerce shipping method

Returns:

the commerce shipping method

Throws:

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

getCommerceShippingMethods

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceShippingMethod> getCommerceShippingMethods(int start,
                                                                                                                                     int end)

Returns a range of all the commerce shipping 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 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.model.impl.CommerceShippingMethodModelImpl.

Parameters:

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

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

Returns:

the range of commerce shipping methods

getCommerceShippingMethods

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

getCommerceShippingMethods

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

getCommerceShippingMethods

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

getCommerceShippingMethodsCount

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

Returns the number of commerce shipping methods.

Returns:

the number of commerce shipping methods

getCommerceShippingMethodsCount

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

CommerceShippingMethod setActive(long commerceShippingMethodId,
                                 boolean active)
                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceShippingMethod

@Indexable(type=REINDEX)
CommerceShippingMethod updateCommerceShippingMethod(CommerceShippingMethod commerceShippingMethod)

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

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

commerceShippingMethod - the commerce shipping method

Returns:

the commerce shipping method that was updated

updateCommerceShippingMethod

CommerceShippingMethod updateCommerceShippingMethod(long commerceShippingMethodId,
                                                    java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                    java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                    java.io.File imageFile,
                                                    double priority,
                                                    boolean active)
                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException