com.liferay.commerce.service

Interface CommerceShipmentLocalService

All Superinterfaces:

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

All Known Implementing Classes:

CommerceShipmentLocalServiceWrapper

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

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

CommerceShipmentLocalServiceUtil, com.liferay.commerce.service.base.CommerceShipmentLocalServiceBaseImpl, com.liferay.commerce.service.impl.CommerceShipmentLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
CommerceShipment	addCommerceShipment(CommerceShipment commerceShipment) Adds the commerce shipment to the database.
CommerceShipment	addCommerceShipment(long commerceOrderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
CommerceShipment	createCommerceShipment(long commerceShipmentId) Creates a new commerce shipment with the primary key.
CommerceShipment	deleteCommerceShipment(CommerceShipment commerceShipment) Deletes the commerce shipment from the database.
CommerceShipment	deleteCommerceShipment(long commerceShipmentId) Deletes the commerce shipment with the primary key from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
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.
CommerceShipment	fetchCommerceShipment(long commerceShipmentId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
CommerceShipment	getCommerceShipment(long commerceShipmentId) Returns the commerce shipment with the primary key.
java.util.List<CommerceShipment>	getCommerceShipments(int start, int end) Returns a range of all the commerce shipments.
java.util.List<CommerceShipment>	getCommerceShipmentsByG_S(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
java.util.List<CommerceShipment>	getCommerceShipmentsByGroupId(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
java.util.List<CommerceShipment>	getCommerceShipmentsByS_S(long siteGroupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
java.util.List<CommerceShipment>	getCommerceShipmentsBySiteGroupId(long siteGroupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
int	getCommerceShipmentsCount() Returns the number of commerce shipments.
int	getCommerceShipmentsCountByG_S(long groupId, int status)
int	getCommerceShipmentsCountByGroupId(long groupId)
int	getCommerceShipmentsCountByS_S(long siteGroupId, int status)
int	getCommerceShipmentsCountBySiteGroupId(long siteGroupId)
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)
CommerceShipment	updateCommerceShipment(CommerceShipment commerceShipment) Updates the commerce shipment in the database or adds it if it does not yet exist.
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)
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 commerceRegionId, long commerceCountryId, 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)

Method Detail

addCommerceShipment

@Indexable(type=REINDEX)
CommerceShipment addCommerceShipment(CommerceShipment commerceShipment)

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

Parameters:

commerceShipment - the commerce shipment

Returns:

the commerce shipment that was added

addCommerceShipment

@Indexable(type=REINDEX)
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

createCommerceShipment

@Transactional(enabled=false)
CommerceShipment createCommerceShipment(long commerceShipmentId)

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

Parameters:

commerceShipmentId - the primary key for the new commerce shipment

Returns:

the new commerce shipment

deleteCommerceShipment

@Indexable(type=DELETE)
 @SystemEvent(type=1)
CommerceShipment deleteCommerceShipment(CommerceShipment commerceShipment)

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

Parameters:

commerceShipment - the commerce shipment

Returns:

the commerce shipment that was removed

deleteCommerceShipment

@Indexable(type=DELETE)
CommerceShipment deleteCommerceShipment(long commerceShipmentId)
                                                         throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

commerceShipmentId - the primary key of the commerce shipment

Returns:

the commerce shipment that was removed

Throws:

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

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

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery 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.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

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

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

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

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

fetchCommerceShipment

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceShipment fetchCommerceShipment(long commerceShipmentId)

getActionableDynamicQuery

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

getCommerceShipment

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceShipment getCommerceShipment(long commerceShipmentId)
                                                                                                 throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce shipment with the primary key.

Parameters:

commerceShipmentId - the primary key of the commerce shipment

Returns:

the commerce shipment

Throws:

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

getCommerceShipments

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

Returns a range of all the commerce shipments.

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.CommerceShipmentModelImpl. 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 shipments

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

Returns:

the range of commerce shipments

getCommerceShipmentsByG_S

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceShipment> getCommerceShipmentsByG_S(long groupId,
                                                                                                                              int status,
                                                                                                                              int start,
                                                                                                                              int end,
                                                                                                                              com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)

getCommerceShipmentsByGroupId

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

getCommerceShipmentsByS_S

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceShipment> getCommerceShipmentsByS_S(long siteGroupId,
                                                                                                                              int status,
                                                                                                                              int start,
                                                                                                                              int end,
                                                                                                                              com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)

getCommerceShipmentsBySiteGroupId

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

getCommerceShipmentsCount

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

Returns the number of commerce shipments.

Returns:

the number of commerce shipments

getCommerceShipmentsCountByG_S

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceShipmentsCountByG_S(long groupId,
                                                                                                      int status)

getCommerceShipmentsCountByGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceShipmentsCountByGroupId(long groupId)

getCommerceShipmentsCountByS_S

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceShipmentsCountByS_S(long siteGroupId,
                                                                                                      int status)

getCommerceShipmentsCountBySiteGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceShipmentsCountBySiteGroupId(long siteGroupId)

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

updateCommerceShipment

@Indexable(type=REINDEX)
CommerceShipment updateCommerceShipment(CommerceShipment commerceShipment)

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

Parameters:

commerceShipment - the commerce shipment

Returns:

the commerce shipment that was updated

updateCommerceShipment

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

@Indexable(type=REINDEX)
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 commerceRegionId,
                                                                 long commerceCountryId,
                                                                 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