com.liferay.commerce.service

Class CommerceShippingMethodLocalServiceUtil

java.lang.Object

com.liferay.commerce.service.CommerceShippingMethodLocalServiceUtil

@ProviderType
public class CommerceShippingMethodLocalServiceUtil
extends java.lang.Object

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

CommerceShippingMethodLocalService, com.liferay.commerce.service.base.CommerceShippingMethodLocalServiceBaseImpl, com.liferay.commerce.service.impl.CommerceShippingMethodLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
CommerceShippingMethodLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CommerceShippingMethod	addCommerceShippingMethod(CommerceShippingMethod commerceShippingMethod) Adds the commerce shipping method to the database.
static CommerceShippingMethod	addCommerceShippingMethod(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, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceShippingMethod	createCommerceShippingMethod(long commerceShippingMethodId) Creates a new commerce shipping method with the primary key.
static CommerceShippingMethod	deleteCommerceShippingMethod(CommerceShippingMethod commerceShippingMethod) Deletes the commerce shipping method from the database.
static CommerceShippingMethod	deleteCommerceShippingMethod(long commerceShippingMethodId) Deletes the commerce shipping method with the primary key from the database.
static void	deleteCommerceShippingMethods(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 CommerceShippingMethod	fetchCommerceShippingMethod(long commerceShippingMethodId)
static CommerceShippingMethod	fetchCommerceShippingMethod(long groupId, java.lang.String engineKey)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static CommerceShippingMethod	getCommerceShippingMethod(long commerceShippingMethodId) Returns the commerce shipping method with the primary key.
static java.util.List<CommerceShippingMethod>	getCommerceShippingMethods(int start, int end) Returns a range of all the commerce shipping methods.
static java.util.List<CommerceShippingMethod>	getCommerceShippingMethods(long groupId)
static java.util.List<CommerceShippingMethod>	getCommerceShippingMethods(long groupId, boolean active)
static int	getCommerceShippingMethodsCount() Returns the number of commerce shipping methods.
static int	getCommerceShippingMethodsCount(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 CommerceShippingMethodLocalService	getService()
static CommerceShippingMethod	setActive(long commerceShippingMethodId, boolean active)
static CommerceShippingMethod	updateCommerceShippingMethod(CommerceShippingMethod commerceShippingMethod) Updates the commerce shipping method in the database or adds it if it does not yet exist.
static 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 class java.lang.Object

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

Constructor Detail

CommerceShippingMethodLocalServiceUtil

public CommerceShippingMethodLocalServiceUtil()

Method Detail

addCommerceShippingMethod

public static CommerceShippingMethod addCommerceShippingMethod(CommerceShippingMethod commerceShippingMethod)

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

Parameters:

commerceShippingMethod - the commerce shipping method

Returns:

the commerce shipping method that was added

addCommerceShippingMethod

public static CommerceShippingMethod addCommerceShippingMethod(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,
                                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceShippingMethod

public static 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

deleteCommerceShippingMethod

public static 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.

Parameters:

commerceShippingMethod - the commerce shipping method

Returns:

the commerce shipping method that was removed

Throws:

PortalException

deleteCommerceShippingMethod

public static 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.

Parameters:

commerceShippingMethodId - the primary key of the commerce shipping method

Returns:

the commerce shipping method that was removed

Throws:

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

deleteCommerceShippingMethods

public static void deleteCommerceShippingMethods(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.CommerceShippingMethodModelImpl. 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.CommerceShippingMethodModelImpl. 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

fetchCommerceShippingMethod

public static CommerceShippingMethod fetchCommerceShippingMethod(long commerceShippingMethodId)

fetchCommerceShippingMethod

public static CommerceShippingMethod fetchCommerceShippingMethod(long groupId,
                                                                 java.lang.String engineKey)

getActionableDynamicQuery

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

getCommerceShippingMethod

public static 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:

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

getCommerceShippingMethods

public static 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 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.CommerceShippingMethodModelImpl. 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 shipping methods

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

Returns:

the range of commerce shipping methods

getCommerceShippingMethods

public static java.util.List<CommerceShippingMethod> getCommerceShippingMethods(long groupId)

getCommerceShippingMethods

public static java.util.List<CommerceShippingMethod> getCommerceShippingMethods(long groupId,
                                                                                boolean active)

getCommerceShippingMethodsCount

public static int getCommerceShippingMethodsCount()

Returns the number of commerce shipping methods.

Returns:

the number of commerce shipping methods

getCommerceShippingMethodsCount

public static int getCommerceShippingMethodsCount(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 CommerceShippingMethod setActive(long commerceShippingMethodId,
                                               boolean active)
                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceShippingMethod

public static 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.

Parameters:

commerceShippingMethod - the commerce shipping method

Returns:

the commerce shipping method that was updated

updateCommerceShippingMethod

public static 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

getService

public static CommerceShippingMethodLocalService getService()