Class CommerceShippingMethodLocalServiceUtil

java.lang.Object
com.liferay.commerce.service.CommerceShippingMethodLocalServiceUtil

public class CommerceShippingMethodLocalServiceUtil extends Object
Provides the local service utility for CommerceShippingMethod. This utility wraps com.liferay.commerce.service.impl.CommerceShippingMethodLocalServiceImpl 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:
Generated:
  • Constructor Details

    • CommerceShippingMethodLocalServiceUtil

      public CommerceShippingMethodLocalServiceUtil()
  • Method Details

    • addCommerceAddressRestriction

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

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

      public static CommerceShippingMethod addCommerceShippingMethod(long userId, long groupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, String engineKey, File imageFile, double priority, String trackingURL) 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
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCommerceAddressRestriction

      public static void deleteCommerceAddressRestriction(long commerceAddressRestrictionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.

      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

      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.

      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

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

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

      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, String engineKey)
    • getActionableDynamicQuery

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

      public static List<CommerceAddressRestriction> getCommerceAddressRestrictions(long commerceShippingMethodId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceAddressRestriction> orderByComparator)
    • getCommerceAddressRestrictionsCount

      public static int getCommerceAddressRestrictionsCount(long commerceShippingMethodId)
    • 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:
      com.liferay.portal.kernel.exception.PortalException - if a commerce shipping method with the primary key could not be found
    • getCommerceShippingMethods

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

      public static List<CommerceShippingMethod> getCommerceShippingMethods(long groupId, boolean active, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShippingMethod> orderByComparator)
    • getCommerceShippingMethods

      public static List<CommerceShippingMethod> getCommerceShippingMethods(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShippingMethod> orderByComparator)
    • getCommerceShippingMethods

      public static List<CommerceShippingMethod> getCommerceShippingMethods(long groupId, long countryId, 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)
    • getCommerceShippingMethodsCount

      public static int getCommerceShippingMethodsCount(long groupId, boolean active)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(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.

      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

      public static CommerceShippingMethod updateCommerceShippingMethod(long commerceShippingMethodId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, File imageFile, double priority, String trackingURL) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CommerceShippingMethodLocalService getService()