com.liferay.commerce.service

Class CommerceShipmentLocalServiceUtil

java.lang.Object

com.liferay.commerce.service.CommerceShipmentLocalServiceUtil

public class CommerceShipmentLocalServiceUtil
extends java.lang.Object

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

CommerceShipmentLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
CommerceShipmentLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CommerceShipment	addCommerceShipment(CommerceShipment commerceShipment) Adds the commerce shipment to the database.
static CommerceShipment	addCommerceShipment(long commerceOrderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceShipment	createCommerceShipment(long commerceShipmentId) Creates a new commerce shipment with the primary key.
static CommerceShipment	deleteCommerceShipment(CommerceShipment commerceShipment) Deletes the commerce shipment from the database.
static CommerceShipment	deleteCommerceShipment(long commerceShipmentId) Deletes the commerce shipment with the primary key from the database.
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 CommerceShipment	fetchCommerceShipment(long commerceShipmentId)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static CommerceShipment	getCommerceShipment(long commerceShipmentId) Returns the commerce shipment with the primary key.
static java.util.List<CommerceShipment>	getCommerceShipments(int start, int end) Returns a range of all the commerce shipments.
static java.util.List<CommerceShipment>	getCommerceShipments(long[] groupIds, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
static java.util.List<CommerceShipment>	getCommerceShipments(long[] groupIds, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
static int	getCommerceShipmentsCount() Returns the number of commerce shipments.
static int	getCommerceShipmentsCount(long[] groupIds)
static int	getCommerceShipmentsCount(long[] groupIds, int status)
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 CommerceShipmentLocalService	getService()
static CommerceShipment	updateCommerceShipment(CommerceShipment commerceShipment) Updates the commerce shipment in the database or adds it if it does not yet exist.
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 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)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommerceShipmentLocalServiceUtil

public CommerceShipmentLocalServiceUtil()

Method Detail

addCommerceShipment

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

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

createCommerceShipment

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

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

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

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

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

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

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

fetchCommerceShipment

public static CommerceShipment fetchCommerceShipment(long commerceShipmentId)

getActionableDynamicQuery

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

getCommerceShipment

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

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

getCommerceShipments

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

getCommerceShipments

public static java.util.List<CommerceShipment> getCommerceShipments(long[] groupIds,
                                                                    int status,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)

getCommerceShipments

public static java.util.List<CommerceShipment> getCommerceShipments(long[] groupIds,
                                                                    int start,
                                                                    int end,
                                                                    com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)

getCommerceShipmentsCount

public static int getCommerceShipmentsCount()

Returns the number of commerce shipments.

Returns:

the number of commerce shipments

getCommerceShipmentsCount

public static int getCommerceShipmentsCount(long[] groupIds)

getCommerceShipmentsCount

public static int getCommerceShipmentsCount(long[] groupIds,
                                            int status)

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

updateCommerceShipment

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

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

getService

public static CommerceShipmentLocalService getService()