public class CommerceShipmentLocalServiceUtil
extends java.lang.Object
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.CommerceShipmentLocalService
Constructor and Description |
---|
CommerceShipmentLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static CommerceShipment |
addCommerceDeliverySubscriptionShipment(long userId,
long commerceOrderId,
java.lang.String name,
java.lang.String description,
java.lang.String street1,
java.lang.String street2,
java.lang.String street3,
java.lang.String city,
java.lang.String zip,
long regionId,
long countryId,
java.lang.String phoneNumber)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
addDeliverySubscriptionCommerceShipment(long, long) |
static CommerceShipment |
addCommerceShipment(CommerceShipment commerceShipment)
Adds the commerce shipment to the database.
|
static CommerceShipment |
addCommerceShipment(long groupId,
long commerceAccountId,
long commerceAddressId,
long commerceShippingMethodId,
java.lang.String commerceShippingOptionName,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static CommerceShipment |
addCommerceShipment(long commerceOrderId,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static CommerceShipment |
addDeliverySubscriptionCommerceShipment(long userId,
long commerceOrderItemId) |
static CommerceShipment |
createCommerceShipment(long commerceShipmentId)
Creates a new commerce shipment with the primary key.
|
static com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
static CommerceShipment |
deleteCommerceShipment(CommerceShipment commerceShipment)
Deletes the commerce shipment from the database.
|
static CommerceShipment |
deleteCommerceShipment(CommerceShipment commerceShipment,
boolean restoreStockQuantity) |
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 <T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
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 java.util.List<CommerceShipment> |
getCommerceShipments(long[] groupIds,
long commerceAddressId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator) |
static java.util.List<CommerceShipment> |
getCommerceShipments(long commerceOrderId,
int start,
int end) |
static java.util.List<CommerceShipment> |
getCommerceShipments(long companyId,
long[] groupIds,
long[] commerceAccountIds,
java.lang.String keywords,
int[] shipmentStatuses,
boolean excludeShipmentStatus,
int start,
int end) |
static int |
getCommerceShipmentsCount()
Returns the number of commerce shipments.
|
static int |
getCommerceShipmentsCount(long commerceOrderId) |
static int |
getCommerceShipmentsCount(long[] groupIds) |
static int |
getCommerceShipmentsCount(long[] groupIds,
int status) |
static int |
getCommerceShipmentsCount(long[] groupIds,
long commerceAddressId) |
static int |
getCommerceShipmentsCount(long companyId,
long[] groupIds,
long[] commerceAccountIds,
java.lang.String keywords,
int[] shipmentStatuses,
boolean excludeShipmentStatus) |
static int[] |
getCommerceShipmentStatusesByCommerceOrderId(long commerceOrderId) |
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 |
reprocessCommerceShipment(long commerceShipmentId) |
static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceShipment> |
searchCommerceShipments(com.liferay.portal.kernel.search.SearchContext searchContext) |
static long |
searchCommerceShipmentsCount(com.liferay.portal.kernel.search.SearchContext searchContext) |
static CommerceShipment |
updateAddress(long commerceShipmentId,
java.lang.String name,
java.lang.String description,
java.lang.String street1,
java.lang.String street2,
java.lang.String street3,
java.lang.String city,
java.lang.String zip,
long regionId,
long countryId,
java.lang.String phoneNumber)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
updateAddress(long, String, String, String, String, String, String,
String, long, long, String, ServiceContext) |
static CommerceShipment |
updateAddress(long commerceShipmentId,
java.lang.String name,
java.lang.String description,
java.lang.String street1,
java.lang.String street2,
java.lang.String street3,
java.lang.String city,
java.lang.String zip,
long regionId,
long countryId,
java.lang.String phoneNumber,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static CommerceShipment |
updateCarrierDetails(long commerceShipmentId,
java.lang.String carrier,
java.lang.String trackingNumber) |
static CommerceShipment |
updateCommerceShipment(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 regionId,
long countryId,
java.lang.String phoneNumber,
java.lang.String carrier,
java.lang.String trackingNumber,
int status,
int shippingDateMonth,
int shippingDateDay,
int shippingDateYear,
int shippingDateHour,
int shippingDateMinute,
int expectedDateMonth,
int expectedDateDay,
int expectedDateYear,
int expectedDateHour,
int expectedDateMinute) |
static CommerceShipment |
updateExpectedDate(long commerceShipmentId,
int expectedDateMonth,
int expectedDateDay,
int expectedDateYear,
int expectedDateHour,
int expectedDateMinute) |
static CommerceShipment |
updateShippingDate(long commerceShipmentId,
int shippingDateMonth,
int shippingDateDay,
int shippingDateYear,
int shippingDateHour,
int shippingDateMinute) |
static CommerceShipment |
updateStatus(long commerceShipmentId,
int status) |
@Deprecated public static CommerceShipment addCommerceDeliverySubscriptionShipment(long userId, long commerceOrderId, java.lang.String name, java.lang.String description, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long regionId, long countryId, java.lang.String phoneNumber) throws com.liferay.portal.kernel.exception.PortalException
addDeliverySubscriptionCommerceShipment(long, long)
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment addCommerceShipment(CommerceShipment commerceShipment)
Important: Inspect CommerceShipmentLocalServiceImpl 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.
commerceShipment
- the commerce shipmentpublic static CommerceShipment addCommerceShipment(long groupId, long commerceAccountId, long commerceAddressId, long commerceShippingMethodId, java.lang.String commerceShippingOptionName, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment addCommerceShipment(long commerceOrderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment addDeliverySubscriptionCommerceShipment(long userId, long commerceOrderItemId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment createCommerceShipment(long commerceShipmentId)
commerceShipmentId
- the primary key for the new commerce shipmentpublic static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment deleteCommerceShipment(CommerceShipment commerceShipment)
Important: Inspect CommerceShipmentLocalServiceImpl 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.
commerceShipment
- the commerce shipmentpublic static CommerceShipment deleteCommerceShipment(CommerceShipment commerceShipment, boolean restoreStockQuantity) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment deleteCommerceShipment(long commerceShipmentId) throws com.liferay.portal.kernel.exception.PortalException
Important: Inspect CommerceShipmentLocalServiceImpl 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.
commerceShipmentId
- the primary key of the commerce shipmentcom.liferay.portal.kernel.exception.PortalException
- if a commerce shipment with the primary key could not be foundpublic static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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.CommerceShipmentModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)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)
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.CommerceShipmentModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static CommerceShipment fetchCommerceShipment(long commerceShipmentId)
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static CommerceShipment getCommerceShipment(long commerceShipmentId) throws com.liferay.portal.kernel.exception.PortalException
commerceShipmentId
- the primary key of the commerce shipmentcom.liferay.portal.kernel.exception.PortalException
- if a commerce shipment with the primary key could not be foundpublic static java.util.List<CommerceShipment> getCommerceShipments(int start, int end)
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.CommerceShipmentModelImpl
.
start
- the lower bound of the range of commerce shipmentsend
- the upper bound of the range of commerce shipments (not inclusive)public static java.util.List<CommerceShipment> getCommerceShipments(long commerceOrderId, int start, int end)
public static java.util.List<CommerceShipment> getCommerceShipments(long companyId, long[] groupIds, long[] commerceAccountIds, java.lang.String keywords, int[] shipmentStatuses, boolean excludeShipmentStatus, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static java.util.List<CommerceShipment> getCommerceShipments(long[] groupIds, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
public static java.util.List<CommerceShipment> getCommerceShipments(long[] groupIds, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
public static java.util.List<CommerceShipment> getCommerceShipments(long[] groupIds, long commerceAddressId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CommerceShipment> orderByComparator)
public static int getCommerceShipmentsCount()
public static int getCommerceShipmentsCount(long commerceOrderId)
public static int getCommerceShipmentsCount(long companyId, long[] groupIds, long[] commerceAccountIds, java.lang.String keywords, int[] shipmentStatuses, boolean excludeShipmentStatus) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static int getCommerceShipmentsCount(long[] groupIds)
public static int getCommerceShipmentsCount(long[] groupIds, int status)
public static int getCommerceShipmentsCount(long[] groupIds, long commerceAddressId)
public static int[] getCommerceShipmentStatusesByCommerceOrderId(long commerceOrderId)
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment reprocessCommerceShipment(long commerceShipmentId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.search.BaseModelSearchResult<CommerceShipment> searchCommerceShipments(com.liferay.portal.kernel.search.SearchContext searchContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static long searchCommerceShipmentsCount(com.liferay.portal.kernel.search.SearchContext searchContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Deprecated public static CommerceShipment updateAddress(long commerceShipmentId, java.lang.String name, java.lang.String description, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long regionId, long countryId, java.lang.String phoneNumber) throws com.liferay.portal.kernel.exception.PortalException
updateAddress(long, String, String, String, String, String, String,
String, long, long, String, ServiceContext)
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment updateAddress(long commerceShipmentId, java.lang.String name, java.lang.String description, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long regionId, long countryId, java.lang.String phoneNumber, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment updateCarrierDetails(long commerceShipmentId, java.lang.String carrier, java.lang.String trackingNumber) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment updateCommerceShipment(CommerceShipment commerceShipment)
Important: Inspect CommerceShipmentLocalServiceImpl 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.
commerceShipment
- the commerce shipmentpublic 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
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment updateCommerceShipment(long commerceShipmentId, java.lang.String name, java.lang.String description, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long regionId, long countryId, java.lang.String phoneNumber, java.lang.String carrier, java.lang.String trackingNumber, int status, int shippingDateMonth, int shippingDateDay, int shippingDateYear, int shippingDateHour, int shippingDateMinute, int expectedDateMonth, int expectedDateDay, int expectedDateYear, int expectedDateHour, int expectedDateMinute) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment updateExpectedDate(long commerceShipmentId, int expectedDateMonth, int expectedDateDay, int expectedDateYear, int expectedDateHour, int expectedDateMinute) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment updateShippingDate(long commerceShipmentId, int shippingDateMonth, int shippingDateDay, int shippingDateYear, int shippingDateHour, int shippingDateMinute) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipment updateStatus(long commerceShipmentId, int status) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static CommerceShipmentLocalService getService()