com.liferay.commerce.service

Class CommerceShipmentServiceUtil

java.lang.Object

com.liferay.commerce.service.CommerceShipmentServiceUtil

public class CommerceShipmentServiceUtil
extends java.lang.Object

Provides the remote service utility for CommerceShipment. This utility wraps com.liferay.commerce.service.impl.CommerceShipmentServiceImpl and is an access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

CommerceShipmentService

Generated:

Constructor Summary

Constructors

Constructor and Description
CommerceShipmentServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CommerceShipment	addCommerceShipment(long groupId, long commerceAccountId, long commerceAddressId, long commerceShippingMethodId, java.lang.String commerceShippingOptionName, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceShipment	addCommerceShipment(long commerceOrderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	deleteCommerceShipment(long commerceShipmentId) Deprecated. As of Mueller (7.2.x), pass boolean for restoring stock
static void	deleteCommerceShipment(long commerceShipmentId, boolean restoreStockQuantity)
static CommerceShipment	getCommerceShipment(long commerceShipmentId)
static java.util.List<CommerceShipment>	getCommerceShipments(long companyId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
static java.util.List<CommerceShipment>	getCommerceShipments(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
static java.util.List<CommerceShipment>	getCommerceShipments(long companyId, long[] groupIds, long[] commerceAccountIds, java.lang.String keywords, int[] shipmentStatuses, boolean excludeShipmentStatus, int start, int end)
static java.util.List<CommerceShipment>	getCommerceShipments(long companyId, long commerceAddressId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
static java.util.List<CommerceShipment>	getCommerceShipmentsByOrderId(long commerceOrderId, int start, int end)
static int	getCommerceShipmentsCount(long companyId)
static int	getCommerceShipmentsCount(long companyId, int status)
static int	getCommerceShipmentsCount(long companyId, long commerceAddressId)
static int	getCommerceShipmentsCount(long companyId, long[] groupIds, long[] commerceAccountIds, java.lang.String keywords, int[] shipmentStatuses, boolean excludeShipmentStatus)
static int	getCommerceShipmentsCountByOrderId(long commerceOrderId)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static CommerceShipmentService	getService()
static CommerceShipment	reprocessCommerceShipment(long commerceShipmentId)
static CommerceShipment	updateAddress(long commerceShipmentId, java.lang.String name, java.lang.String description, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long regionId, long countryId, java.lang.String phoneNumber) Deprecated. As of Cavanaugh (7.4.x), replaced by updateAddress(long, String, String, String, String, String, String, String, long, long, String, ServiceContext)
static CommerceShipment	updateAddress(long commerceShipmentId, java.lang.String name, java.lang.String description, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long regionId, long countryId, java.lang.String phoneNumber, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceShipment	updateCarrierDetails(long commerceShipmentId, java.lang.String carrier, java.lang.String trackingNumber)
static CommerceShipment	updateCommerceShipment(long commerceShipmentId, java.lang.String carrier, java.lang.String trackingNumber, int status, int shippingDateMonth, int shippingDateDay, int shippingDateYear, int shippingDateHour, int shippingDateMinute, int expectedDateMonth, int expectedDateDay, int expectedDateYear, int expectedDateHour, int expectedDateMinute)
static CommerceShipment	updateCommerceShipment(long commerceShipmentId, java.lang.String name, java.lang.String description, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long regionId, long countryId, java.lang.String phoneNumber, java.lang.String carrier, java.lang.String trackingNumber, int status, int shippingDateMonth, int shippingDateDay, int shippingDateYear, int shippingDateHour, int shippingDateMinute, int expectedDateMonth, int expectedDateDay, int expectedDateYear, int expectedDateHour, int expectedDateMinute)
static CommerceShipment	updateExpectedDate(long commerceShipmentId, int expectedDateMonth, int expectedDateDay, int expectedDateYear, int expectedDateHour, int expectedDateMinute)
static CommerceShipment	updateShippingDate(long commerceShipmentId, int shippingDateMonth, int shippingDateDay, int shippingDateYear, int shippingDateHour, int shippingDateMinute)
static CommerceShipment	updateStatus(long commerceShipmentId, int status)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommerceShipmentServiceUtil

public CommerceShipmentServiceUtil()

Method Detail

addCommerceShipment

public static CommerceShipment addCommerceShipment(long groupId,
                                                   long commerceAccountId,
                                                   long commerceAddressId,
                                                   long commerceShippingMethodId,
                                                   java.lang.String commerceShippingOptionName,
                                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addCommerceShipment

public static CommerceShipment addCommerceShipment(long commerceOrderId,
                                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceShipment

@Deprecated
public static void deleteCommerceShipment(long commerceShipmentId)
                                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Mueller (7.2.x), pass boolean for restoring stock

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceShipment

public static void deleteCommerceShipment(long commerceShipmentId,
                                          boolean restoreStockQuantity)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceShipment

public static CommerceShipment getCommerceShipment(long commerceShipmentId)
                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceShipments

public static java.util.List<CommerceShipment> getCommerceShipments(long companyId,
                                                                    int status,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceShipments

public static java.util.List<CommerceShipment> getCommerceShipments(long companyId,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceShipments

public static java.util.List<CommerceShipment> getCommerceShipments(long companyId,
                                                                    long commerceAddressId,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceShipments

public static java.util.List<CommerceShipment> getCommerceShipments(long companyId,
                                                                    long[] groupIds,
                                                                    long[] commerceAccountIds,
                                                                    java.lang.String keywords,
                                                                    int[] shipmentStatuses,
                                                                    boolean excludeShipmentStatus,
                                                                    int start,
                                                                    int end)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceShipmentsByOrderId

public static java.util.List<CommerceShipment> getCommerceShipmentsByOrderId(long commerceOrderId,
                                                                             int start,
                                                                             int end)

getCommerceShipmentsCount

public static int getCommerceShipmentsCount(long companyId)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceShipmentsCount

public static int getCommerceShipmentsCount(long companyId,
                                            int status)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceShipmentsCount

public static int getCommerceShipmentsCount(long companyId,
                                            long commerceAddressId)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceShipmentsCount

public static int getCommerceShipmentsCount(long companyId,
                                            long[] groupIds,
                                            long[] commerceAccountIds,
                                            java.lang.String keywords,
                                            int[] shipmentStatuses,
                                            boolean excludeShipmentStatus)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceShipmentsCountByOrderId

public static int getCommerceShipmentsCountByOrderId(long commerceOrderId)

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

reprocessCommerceShipment

public static CommerceShipment reprocessCommerceShipment(long commerceShipmentId)
                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateAddress

@Deprecated
public static CommerceShipment updateAddress(long commerceShipmentId,
                                                         java.lang.String name,
                                                         java.lang.String description,
                                                         java.lang.String street1,
                                                         java.lang.String street2,
                                                         java.lang.String street3,
                                                         java.lang.String city,
                                                         java.lang.String zip,
                                                         long regionId,
                                                         long countryId,
                                                         java.lang.String phoneNumber)
                                                  throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Cavanaugh (7.4.x), replaced by updateAddress(long, String, String, String, String, String, String, String, long, long, String, ServiceContext)

Throws:

com.liferay.portal.kernel.exception.PortalException

updateAddress

public static CommerceShipment updateAddress(long commerceShipmentId,
                                             java.lang.String name,
                                             java.lang.String description,
                                             java.lang.String street1,
                                             java.lang.String street2,
                                             java.lang.String street3,
                                             java.lang.String city,
                                             java.lang.String zip,
                                             long regionId,
                                             long countryId,
                                             java.lang.String phoneNumber,
                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCarrierDetails

public static CommerceShipment updateCarrierDetails(long commerceShipmentId,
                                                    java.lang.String carrier,
                                                    java.lang.String trackingNumber)
                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceShipment

public static CommerceShipment updateCommerceShipment(long commerceShipmentId,
                                                      java.lang.String carrier,
                                                      java.lang.String trackingNumber,
                                                      int status,
                                                      int shippingDateMonth,
                                                      int shippingDateDay,
                                                      int shippingDateYear,
                                                      int shippingDateHour,
                                                      int shippingDateMinute,
                                                      int expectedDateMonth,
                                                      int expectedDateDay,
                                                      int expectedDateYear,
                                                      int expectedDateHour,
                                                      int expectedDateMinute)
                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceShipment

public static CommerceShipment updateCommerceShipment(long commerceShipmentId,
                                                      java.lang.String name,
                                                      java.lang.String description,
                                                      java.lang.String street1,
                                                      java.lang.String street2,
                                                      java.lang.String street3,
                                                      java.lang.String city,
                                                      java.lang.String zip,
                                                      long regionId,
                                                      long countryId,
                                                      java.lang.String phoneNumber,
                                                      java.lang.String carrier,
                                                      java.lang.String trackingNumber,
                                                      int status,
                                                      int shippingDateMonth,
                                                      int shippingDateDay,
                                                      int shippingDateYear,
                                                      int shippingDateHour,
                                                      int shippingDateMinute,
                                                      int expectedDateMonth,
                                                      int expectedDateDay,
                                                      int expectedDateYear,
                                                      int expectedDateHour,
                                                      int expectedDateMinute)
                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateExpectedDate

public static CommerceShipment updateExpectedDate(long commerceShipmentId,
                                                  int expectedDateMonth,
                                                  int expectedDateDay,
                                                  int expectedDateYear,
                                                  int expectedDateHour,
                                                  int expectedDateMinute)
                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateShippingDate

public static CommerceShipment updateShippingDate(long commerceShipmentId,
                                                  int shippingDateMonth,
                                                  int shippingDateDay,
                                                  int shippingDateYear,
                                                  int shippingDateHour,
                                                  int shippingDateMinute)
                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateStatus

public static CommerceShipment updateStatus(long commerceShipmentId,
                                            int status)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CommerceShipmentService getService()