com.liferay.commerce.service

Interface CommerceShipmentItemLocalService

All Superinterfaces:

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

All Known Implementing Classes:

CommerceShipmentItemLocalServiceWrapper

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

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

CommerceShipmentItemLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
CommerceShipmentItem	addCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem) Adds the commerce shipment item to the database.
CommerceShipmentItem	addCommerceShipmentItem(long commerceShipmentId, long commerceOrderItemId, long commerceInventoryWarehouseId, int quantity, com.liferay.portal.kernel.service.ServiceContext serviceContext)
CommerceShipmentItem	addDeliverySubscriptionCommerceShipmentItem(long groupId, long userId, long commerceShipmentId, long commerceOrderItemId)
CommerceShipmentItem	createCommerceShipmentItem(long commerceShipmentItemId) Creates a new commerce shipment item with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
CommerceShipmentItem	deleteCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem) Deletes the commerce shipment item from the database.
CommerceShipmentItem	deleteCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem, boolean restoreStockQuantity)
CommerceShipmentItem	deleteCommerceShipmentItem(long commerceShipmentItemId) Deletes the commerce shipment item with the primary key from the database.
void	deleteCommerceShipmentItem(long commerceShipmentItemId, boolean restoreStockQuantity)
void	deleteCommerceShipmentItems(long commerceShipmentId, boolean restoreStockQuantity)
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.
CommerceShipmentItem	fetchCommerceShipmentItem(long commerceShipmentItemId)
CommerceShipmentItem	fetchCommerceShipmentItem(long commerceShipmentId, long commerceOrderItemId, long commerceInventoryWarehouseId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
CommerceShipmentItem	getCommerceShipmentItem(long commerceShipmentItemId) Returns the commerce shipment item with the primary key.
java.util.List<CommerceShipmentItem>	getCommerceShipmentItems(int start, int end) Returns a range of all the commerce shipment items.
java.util.List<CommerceShipmentItem>	getCommerceShipmentItems(long commerceOrderItemId) Deprecated. As of Athanasius (7.3.x)
java.util.List<CommerceShipmentItem>	getCommerceShipmentItems(long commerceShipmentId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipmentItem> orderByComparator)
java.util.List<CommerceShipmentItem>	getCommerceShipmentItems(long commerceShipmentId, long commerceOrderItemId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipmentItem> orderByComparator)
java.util.List<CommerceShipmentItem>	getCommerceShipmentItemsByCommerceOrderItemId(long commerceOrderItemId)
int	getCommerceShipmentItemsCount() Returns the number of commerce shipment items.
int	getCommerceShipmentItemsCount(long commerceShipmentId)
int	getCommerceShipmentItemsCountByCommerceOrderItemId(long commerceOrderItemId)
int	getCommerceShipmentOrderItemsQuantity(long commerceShipmentId, long commerceOrderItemId)
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)
CommerceShipmentItem	updateCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem) Updates the commerce shipment item in the database or adds it if it does not yet exist.
CommerceShipmentItem	updateCommerceShipmentItem(long commerceShipmentItemId, int quantity)
CommerceShipmentItem	updateCommerceShipmentItem(long commerceShipmentItemId, long commerceInventoryWarehouseId, int quantity)

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

getBasePersistence

Method Detail

addCommerceShipmentItem

@Indexable(type=REINDEX)
CommerceShipmentItem addCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem)

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

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

commerceShipmentItem - the commerce shipment item

Returns:

the commerce shipment item that was added

addCommerceShipmentItem

@Indexable(type=REINDEX)
CommerceShipmentItem addCommerceShipmentItem(long commerceShipmentId,
                                                                      long commerceOrderItemId,
                                                                      long commerceInventoryWarehouseId,
                                                                      int quantity,
                                                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addDeliverySubscriptionCommerceShipmentItem

@Indexable(type=REINDEX)
CommerceShipmentItem addDeliverySubscriptionCommerceShipmentItem(long groupId,
                                                                                          long userId,
                                                                                          long commerceShipmentId,
                                                                                          long commerceOrderItemId)
                                                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceShipmentItem

@Transactional(enabled=false)
CommerceShipmentItem createCommerceShipmentItem(long commerceShipmentItemId)

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

Parameters:

commerceShipmentItemId - the primary key for the new commerce shipment item

Returns:

the new commerce shipment item

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

deleteCommerceShipmentItem

@Indexable(type=DELETE)
CommerceShipmentItem deleteCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem)

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

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

commerceShipmentItem - the commerce shipment item

Returns:

the commerce shipment item that was removed

deleteCommerceShipmentItem

@Indexable(type=DELETE)
 @SystemEvent(type=1)
CommerceShipmentItem deleteCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem,
                                                                                              boolean restoreStockQuantity)
                                                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceShipmentItem

@Indexable(type=DELETE)
CommerceShipmentItem deleteCommerceShipmentItem(long commerceShipmentItemId)
                                                                 throws com.liferay.portal.kernel.exception.PortalException

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

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

commerceShipmentItemId - the primary key of the commerce shipment item

Returns:

the commerce shipment item that was removed

Throws:

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

deleteCommerceShipmentItem

void deleteCommerceShipmentItem(long commerceShipmentItemId,
                                boolean restoreStockQuantity)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceShipmentItems

void deleteCommerceShipmentItems(long commerceShipmentId,
                                 boolean restoreStockQuantity)
                          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.CommerceShipmentItemModelImpl.

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.CommerceShipmentItemModelImpl.

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

fetchCommerceShipmentItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceShipmentItem fetchCommerceShipmentItem(long commerceShipmentItemId)

fetchCommerceShipmentItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceShipmentItem fetchCommerceShipmentItem(long commerceShipmentId,
                                                                                                                  long commerceOrderItemId,
                                                                                                                  long commerceInventoryWarehouseId)

getActionableDynamicQuery

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

getCommerceShipmentItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceShipmentItem getCommerceShipmentItem(long commerceShipmentItemId)
                                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce shipment item with the primary key.

Parameters:

commerceShipmentItemId - the primary key of the commerce shipment item

Returns:

the commerce shipment item

Throws:

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

getCommerceShipmentItems

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

Returns a range of all the commerce shipment 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, then the query will include the default ORDER BY logic from com.liferay.commerce.model.impl.CommerceShipmentItemModelImpl.

Parameters:

start - the lower bound of the range of commerce shipment items

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

Returns:

the range of commerce shipment items

getCommerceShipmentItems

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceShipmentItem> getCommerceShipmentItems(long commerceOrderItemId)

Deprecated. As of Athanasius (7.3.x)

getCommerceShipmentItems

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

getCommerceShipmentItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceShipmentItem> getCommerceShipmentItems(long commerceShipmentId,
                                                                                                                                 long commerceOrderItemId,
                                                                                                                                 int start,
                                                                                                                                 int end,
                                                                                                                                 com.liferay.portal.kernel.util.OrderByComparator<CommerceShipmentItem> orderByComparator)

getCommerceShipmentItemsByCommerceOrderItemId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceShipmentItem> getCommerceShipmentItemsByCommerceOrderItemId(long commerceOrderItemId)

getCommerceShipmentItemsCount

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

Returns the number of commerce shipment items.

Returns:

the number of commerce shipment items

getCommerceShipmentItemsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceShipmentItemsCount(long commerceShipmentId)

getCommerceShipmentItemsCountByCommerceOrderItemId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceShipmentItemsCountByCommerceOrderItemId(long commerceOrderItemId)

getCommerceShipmentOrderItemsQuantity

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceShipmentOrderItemsQuantity(long commerceShipmentId,
                                                                                                             long commerceOrderItemId)

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

updateCommerceShipmentItem

@Indexable(type=REINDEX)
CommerceShipmentItem updateCommerceShipmentItem(CommerceShipmentItem commerceShipmentItem)

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

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

commerceShipmentItem - the commerce shipment item

Returns:

the commerce shipment item that was updated

updateCommerceShipmentItem

CommerceShipmentItem updateCommerceShipmentItem(long commerceShipmentItemId,
                                                int quantity)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceShipmentItem

@Indexable(type=REINDEX)
CommerceShipmentItem updateCommerceShipmentItem(long commerceShipmentItemId,
                                                                         long commerceInventoryWarehouseId,
                                                                         int quantity)
                                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException