com.liferay.commerce.service

Class CommerceOrderItemLocalServiceUtil

java.lang.Object

com.liferay.commerce.service.CommerceOrderItemLocalServiceUtil

public class CommerceOrderItemLocalServiceUtil
extends java.lang.Object

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

CommerceOrderItemLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
CommerceOrderItemLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CommerceOrderItem	addCommerceOrderItem(CommerceOrderItem commerceOrderItem) Adds the commerce order item to the database.
static CommerceOrderItem	addCommerceOrderItem(long commerceOrderId, long cpInstanceId, int quantity, int shippedQuantity, java.lang.String json, CommerceContext commerceContext, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceOrderItem	createCommerceOrderItem(long commerceOrderItemId) Creates a new commerce order item with the primary key.
static CommerceOrderItem	deleteCommerceOrderItem(CommerceOrderItem commerceOrderItem) Deprecated.
static CommerceOrderItem	deleteCommerceOrderItem(CommerceOrderItem commerceOrderItem, CommerceContext commerceContext)
static CommerceOrderItem	deleteCommerceOrderItem(long commerceOrderItemId) Deletes the commerce order item with the primary key from the database.
static void	deleteCommerceOrderItems(long commerceOrderId)
static void	deleteCommerceOrderItemsByCPInstanceId(long cpInstanceId)
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 CommerceOrderItem	fetchByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode)
static CommerceOrderItem	fetchCommerceOrderItem(long commerceOrderItemId)
static CommerceOrderItem	fetchCommerceOrderItemByReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the commerce order item with the matching external reference code and company.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<CommerceOrderItem>	getAvailableForShipmentCommerceOrderItems(long commerceOrderId)
static int	getCommerceInventoryWarehouseItemQuantity(long commerceOrderItemId, long commerceInventoryWarehouseId)
static CommerceOrderItem	getCommerceOrderItem(long commerceOrderItemId) Returns the commerce order item with the primary key.
static java.util.List<CommerceOrderItem>	getCommerceOrderItems(int start, int end) Returns a range of all the commerce order items.
static java.util.List<CommerceOrderItem>	getCommerceOrderItems(long commerceOrderId, int start, int end)
static java.util.List<CommerceOrderItem>	getCommerceOrderItems(long commerceOrderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceOrderItem> orderByComparator)
static java.util.List<CommerceOrderItem>	getCommerceOrderItems(long commerceOrderId, long cpInstanceId, int start, int end)
static java.util.List<CommerceOrderItem>	getCommerceOrderItems(long commerceOrderId, long cpInstanceId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceOrderItem> orderByComparator)
static int	getCommerceOrderItemsCount() Returns the number of commerce order items.
static int	getCommerceOrderItemsCount(long commerceOrderId)
static int	getCommerceOrderItemsCount(long commerceOrderId, long cpInstanceId)
static int	getCommerceOrderItemsQuantity(long commerceOrderId)
static int	getCPInstanceQuantity(long cpInstanceId, int orderStatus)
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 CommerceOrderItemLocalService	getService()
static java.util.List<CommerceOrderItem>	getSubscriptionCommerceOrderItems(long commerceOrderId)
static CommerceOrderItem	incrementShippedQuantity(long commerceOrderItemId, int shippedQuantity)
static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceOrderItem>	search(long commerceOrderId, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceOrderItem>	search(long commerceOrderId, java.lang.String sku, java.lang.String name, boolean andOperator, int start, int end, com.liferay.portal.kernel.search.Sort sort)
static CommerceOrderItem	updateCommerceOrderItem(CommerceOrderItem commerceOrderItem) Updates the commerce order item in the database or adds it if it does not yet exist.
static CommerceOrderItem	updateCommerceOrderItem(long commerceOrderItemId, int quantity, CommerceContext commerceContext, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceOrderItem	updateCommerceOrderItem(long commerceOrderItemId, int quantity, java.lang.String json, CommerceContext commerceContext, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceOrderItem	updateCommerceOrderItem(long commerceOrderItemId, long bookedQuantityId)
static CommerceOrderItem	updateCommerceOrderItemInfo(long commerceOrderItemId, java.lang.String deliveryGroup, long shippingAddressId, java.lang.String printedNote, int requestedDeliveryDateMonth, int requestedDeliveryDateDay, int requestedDeliveryDateYear, int requestedDeliveryDateHour, int requestedDeliveryDateMinute, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceOrderItem	updateCommerceOrderItemPrice(long commerceOrderItemId, CommerceContext commerceContext)
static CommerceOrderItem	updateCommerceOrderItemPrices(long commerceOrderItemId, java.math.BigDecimal unitPrice, java.math.BigDecimal promoPrice, java.math.BigDecimal discountAmount, java.math.BigDecimal finalPrice, java.math.BigDecimal discountPercentageLevel1, java.math.BigDecimal discountPercentageLevel2, java.math.BigDecimal discountPercentageLevel3, java.math.BigDecimal discountPercentageLevel4)
static CommerceOrderItem	upsertCommerceOrderItem(long commerceOrderId, long cpInstanceId, int quantity, int shippedQuantity, java.lang.String json, CommerceContext commerceContext, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommerceOrderItemLocalServiceUtil

public CommerceOrderItemLocalServiceUtil()

Method Detail

addCommerceOrderItem

public static CommerceOrderItem addCommerceOrderItem(CommerceOrderItem commerceOrderItem)

Adds the commerce order item to the database. Also notifies the appropriate model listeners.

Parameters:

commerceOrderItem - the commerce order item

Returns:

the commerce order item that was added

addCommerceOrderItem

public static CommerceOrderItem addCommerceOrderItem(long commerceOrderId,
                                                     long cpInstanceId,
                                                     int quantity,
                                                     int shippedQuantity,
                                                     java.lang.String json,
                                                     CommerceContext commerceContext,
                                                     com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceOrderItem

public static CommerceOrderItem createCommerceOrderItem(long commerceOrderItemId)

Creates a new commerce order item with the primary key. Does not add the commerce order item to the database.

Parameters:

commerceOrderItemId - the primary key for the new commerce order item

Returns:

the new commerce order item

deleteCommerceOrderItem

@Deprecated
public static CommerceOrderItem deleteCommerceOrderItem(CommerceOrderItem commerceOrderItem)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Deprecated.

Deletes the commerce order item from the database. Also notifies the appropriate model listeners.

Parameters:

commerceOrderItem - the commerce order item

Returns:

the commerce order item that was removed

Throws:

PortalException

deleteCommerceOrderItem

public static CommerceOrderItem deleteCommerceOrderItem(CommerceOrderItem commerceOrderItem,
                                                        CommerceContext commerceContext)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceOrderItem

public static CommerceOrderItem deleteCommerceOrderItem(long commerceOrderItemId)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Deletes the commerce order item with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

commerceOrderItemId - the primary key of the commerce order item

Returns:

the commerce order item that was removed

Throws:

PortalException - if a commerce order item with the primary key could not be found

deleteCommerceOrderItems

public static void deleteCommerceOrderItems(long commerceOrderId)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceOrderItemsByCPInstanceId

public static void deleteCommerceOrderItemsByCPInstanceId(long cpInstanceId)
                                                   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 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.commerce.model.impl.CommerceOrderItemModelImpl. 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 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.commerce.model.impl.CommerceOrderItemModelImpl. 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

fetchByExternalReferenceCode

public static CommerceOrderItem fetchByExternalReferenceCode(long companyId,
                                                             java.lang.String externalReferenceCode)

fetchCommerceOrderItem

public static CommerceOrderItem fetchCommerceOrderItem(long commerceOrderItemId)

fetchCommerceOrderItemByReferenceCode

public static CommerceOrderItem fetchCommerceOrderItemByReferenceCode(long companyId,
                                                                      java.lang.String externalReferenceCode)

Returns the commerce order item with the matching external reference code and company.

Parameters:

companyId - the primary key of the company

externalReferenceCode - the commerce order item's external reference code

Returns:

the matching commerce order item, or null if a matching commerce order item could not be found

getActionableDynamicQuery

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

getAvailableForShipmentCommerceOrderItems

public static java.util.List<CommerceOrderItem> getAvailableForShipmentCommerceOrderItems(long commerceOrderId)

getCommerceInventoryWarehouseItemQuantity

public static int getCommerceInventoryWarehouseItemQuantity(long commerceOrderItemId,
                                                            long commerceInventoryWarehouseId)
                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceOrderItem

public static CommerceOrderItem getCommerceOrderItem(long commerceOrderItemId)
                                              throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce order item with the primary key.

Parameters:

commerceOrderItemId - the primary key of the commerce order item

Returns:

the commerce order item

Throws:

PortalException - if a commerce order item with the primary key could not be found

getCommerceOrderItems

public static java.util.List<CommerceOrderItem> getCommerceOrderItems(int start,
                                                                      int end)

Returns a range of all the commerce order items.

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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.commerce.model.impl.CommerceOrderItemModelImpl. 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 order items

end - the upper bound of the range of commerce order items (not inclusive)

Returns:

the range of commerce order items

getCommerceOrderItems

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

getCommerceOrderItems

public static java.util.List<CommerceOrderItem> getCommerceOrderItems(long commerceOrderId,
                                                                      int start,
                                                                      int end,
                                                                      com.liferay.portal.kernel.util.OrderByComparator<CommerceOrderItem> orderByComparator)

getCommerceOrderItems

public static java.util.List<CommerceOrderItem> getCommerceOrderItems(long commerceOrderId,
                                                                      long cpInstanceId,
                                                                      int start,
                                                                      int end)

getCommerceOrderItems

public static java.util.List<CommerceOrderItem> getCommerceOrderItems(long commerceOrderId,
                                                                      long cpInstanceId,
                                                                      int start,
                                                                      int end,
                                                                      com.liferay.portal.kernel.util.OrderByComparator<CommerceOrderItem> orderByComparator)

getCommerceOrderItemsCount

public static int getCommerceOrderItemsCount()

Returns the number of commerce order items.

Returns:

the number of commerce order items

getCommerceOrderItemsCount

public static int getCommerceOrderItemsCount(long commerceOrderId)

getCommerceOrderItemsCount

public static int getCommerceOrderItemsCount(long commerceOrderId,
                                             long cpInstanceId)

getCommerceOrderItemsQuantity

public static int getCommerceOrderItemsQuantity(long commerceOrderId)

getCPInstanceQuantity

public static int getCPInstanceQuantity(long cpInstanceId,
                                        int orderStatus)

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

getSubscriptionCommerceOrderItems

public static java.util.List<CommerceOrderItem> getSubscriptionCommerceOrderItems(long commerceOrderId)

incrementShippedQuantity

public static CommerceOrderItem incrementShippedQuantity(long commerceOrderItemId,
                                                         int shippedQuantity)
                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

search

public static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceOrderItem> search(long commerceOrderId,
                                                                                               java.lang.String keywords,
                                                                                               int start,
                                                                                               int end,
                                                                                               com.liferay.portal.kernel.search.Sort sort)
                                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

search

public static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceOrderItem> search(long commerceOrderId,
                                                                                               java.lang.String sku,
                                                                                               java.lang.String name,
                                                                                               boolean andOperator,
                                                                                               int start,
                                                                                               int end,
                                                                                               com.liferay.portal.kernel.search.Sort sort)
                                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceOrderItem

public static CommerceOrderItem updateCommerceOrderItem(CommerceOrderItem commerceOrderItem)

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

Parameters:

commerceOrderItem - the commerce order item

Returns:

the commerce order item that was updated

updateCommerceOrderItem

public static CommerceOrderItem updateCommerceOrderItem(long commerceOrderItemId,
                                                        int quantity,
                                                        CommerceContext commerceContext,
                                                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceOrderItem

public static CommerceOrderItem updateCommerceOrderItem(long commerceOrderItemId,
                                                        int quantity,
                                                        java.lang.String json,
                                                        CommerceContext commerceContext,
                                                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceOrderItem

public static CommerceOrderItem updateCommerceOrderItem(long commerceOrderItemId,
                                                        long bookedQuantityId)
                                                 throws NoSuchOrderItemException

Throws:

NoSuchOrderItemException

updateCommerceOrderItemInfo

public static CommerceOrderItem updateCommerceOrderItemInfo(long commerceOrderItemId,
                                                            java.lang.String deliveryGroup,
                                                            long shippingAddressId,
                                                            java.lang.String printedNote,
                                                            int requestedDeliveryDateMonth,
                                                            int requestedDeliveryDateDay,
                                                            int requestedDeliveryDateYear,
                                                            int requestedDeliveryDateHour,
                                                            int requestedDeliveryDateMinute,
                                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceOrderItemPrice

public static CommerceOrderItem updateCommerceOrderItemPrice(long commerceOrderItemId,
                                                             CommerceContext commerceContext)
                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceOrderItemPrices

public static CommerceOrderItem updateCommerceOrderItemPrices(long commerceOrderItemId,
                                                              java.math.BigDecimal unitPrice,
                                                              java.math.BigDecimal promoPrice,
                                                              java.math.BigDecimal discountAmount,
                                                              java.math.BigDecimal finalPrice,
                                                              java.math.BigDecimal discountPercentageLevel1,
                                                              java.math.BigDecimal discountPercentageLevel2,
                                                              java.math.BigDecimal discountPercentageLevel3,
                                                              java.math.BigDecimal discountPercentageLevel4)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

upsertCommerceOrderItem

public static CommerceOrderItem upsertCommerceOrderItem(long commerceOrderId,
                                                        long cpInstanceId,
                                                        int quantity,
                                                        int shippedQuantity,
                                                        java.lang.String json,
                                                        CommerceContext commerceContext,
                                                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CommerceOrderItemLocalService getService()