Liferay 7.0-ce-m3

com.liferay.portlet.shopping.service
Interface ShoppingOrderLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ShoppingOrderLocalServiceBaseImpl, ShoppingOrderLocalServiceImpl, ShoppingOrderLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ShoppingOrderLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for ShoppingOrder. 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:
ShoppingOrderLocalServiceUtil, ShoppingOrderLocalServiceBaseImpl, ShoppingOrderLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 ShoppingOrder addLatestOrder(long userId, long groupId)
           
 ShoppingOrder addShoppingOrder(ShoppingOrder shoppingOrder)
          Adds the shopping order to the database.
 void completeOrder(String number, String ppTxnId, String ppPaymentStatus, double ppPaymentGross, String ppReceiverEmail, String ppPayerEmail, boolean updateInventory, ServiceContext serviceContext)
           
 ShoppingOrder createShoppingOrder(long orderId)
          Creates a new shopping order with the primary key.
 void deleteOrder(long orderId)
           
 void deleteOrder(ShoppingOrder order)
           
 void deleteOrders(long groupId)
           
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 ShoppingOrder deleteShoppingOrder(long orderId)
          Deletes the shopping order with the primary key from the database.
 ShoppingOrder deleteShoppingOrder(ShoppingOrder shoppingOrder)
          Deletes the shopping order from the database.
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 ShoppingOrder fetchShoppingOrder(long orderId)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 ShoppingOrder getLatestOrder(long userId, long groupId)
           
 ShoppingOrder getOrder(long orderId)
           
 ShoppingOrder getOrder(String number)
           
 ShoppingOrder getPayPalTxnIdOrder(String ppTxnId)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 ShoppingOrder getShoppingOrder(long orderId)
          Returns the shopping order with the primary key.
 List<ShoppingOrder> getShoppingOrders(int start, int end)
          Returns a range of all the shopping orders.
 int getShoppingOrdersCount()
          Returns the number of shopping orders.
 ShoppingOrder saveLatestOrder(ShoppingCart cart)
           
 List<ShoppingOrder> search(long groupId, long companyId, long userId, String number, String billingFirstName, String billingLastName, String billingEmailAddress, String shippingFirstName, String shippingLastName, String shippingEmailAddress, String ppPaymentStatus, boolean andOperator, int start, int end)
           
 int searchCount(long groupId, long companyId, long userId, String number, String billingFirstName, String billingLastName, String billingEmailAddress, String shippingFirstName, String shippingLastName, String shippingEmailAddress, String ppPaymentStatus, boolean andOperator)
           
 void sendEmail(long orderId, String emailType, ServiceContext serviceContext)
           
 void sendEmail(ShoppingOrder order, String emailType, ServiceContext serviceContext)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 ShoppingOrder updateLatestOrder(long userId, long groupId, String billingFirstName, String billingLastName, String billingEmailAddress, String billingCompany, String billingStreet, String billingCity, String billingState, String billingZip, String billingCountry, String billingPhone, boolean shipToBilling, String shippingFirstName, String shippingLastName, String shippingEmailAddress, String shippingCompany, String shippingStreet, String shippingCity, String shippingState, String shippingZip, String shippingCountry, String shippingPhone, String ccName, String ccType, String ccNumber, int ccExpMonth, int ccExpYear, String ccVerNumber, String comments)
           
 ShoppingOrder updateOrder(long orderId, String ppTxnId, String ppPaymentStatus, double ppPaymentGross, String ppReceiverEmail, String ppPayerEmail)
           
 ShoppingOrder updateOrder(long orderId, String billingFirstName, String billingLastName, String billingEmailAddress, String billingCompany, String billingStreet, String billingCity, String billingState, String billingZip, String billingCountry, String billingPhone, boolean shipToBilling, String shippingFirstName, String shippingLastName, String shippingEmailAddress, String shippingCompany, String shippingStreet, String shippingCity, String shippingState, String shippingZip, String shippingCountry, String shippingPhone, String ccName, String ccType, String ccNumber, int ccExpMonth, int ccExpYear, String ccVerNumber, String comments)
           
 ShoppingOrder updateShoppingOrder(ShoppingOrder shoppingOrder)
          Updates the shopping order in the database or adds it if it does not yet exist.
 

Method Detail

addLatestOrder

ShoppingOrder addLatestOrder(long userId,
                             long groupId)
                             throws PortalException
Throws:
PortalException

addShoppingOrder

@Indexable(type=REINDEX)
ShoppingOrder addShoppingOrder(ShoppingOrder shoppingOrder)
Adds the shopping order to the database. Also notifies the appropriate model listeners.

Parameters:
shoppingOrder - the shopping order
Returns:
the shopping order that was added

completeOrder

void completeOrder(String number,
                   String ppTxnId,
                   String ppPaymentStatus,
                   double ppPaymentGross,
                   String ppReceiverEmail,
                   String ppPayerEmail,
                   boolean updateInventory,
                   ServiceContext serviceContext)
                   throws PortalException
Throws:
PortalException

createShoppingOrder

ShoppingOrder createShoppingOrder(long orderId)
Creates a new shopping order with the primary key. Does not add the shopping order to the database.

Parameters:
orderId - the primary key for the new shopping order
Returns:
the new shopping order

deleteOrder

void deleteOrder(ShoppingOrder order)
                 throws PortalException
Throws:
PortalException

deleteOrder

void deleteOrder(long orderId)
                 throws PortalException
Throws:
PortalException

deleteOrders

void deleteOrders(long groupId)
                  throws PortalException
Throws:
PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteShoppingOrder

@Indexable(type=DELETE)
ShoppingOrder deleteShoppingOrder(long orderId)
                                  throws PortalException
Deletes the shopping order with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
orderId - the primary key of the shopping order
Returns:
the shopping order that was removed
Throws:
PortalException - if a shopping order with the primary key could not be found

deleteShoppingOrder

@Indexable(type=DELETE)
ShoppingOrder deleteShoppingOrder(ShoppingOrder shoppingOrder)
Deletes the shopping order from the database. Also notifies the appropriate model listeners.

Parameters:
shoppingOrder - the shopping order
Returns:
the shopping order that was removed

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(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> List<T> dynamicQuery(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 ShoppingOrderModelImpl. 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> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         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 ShoppingOrderModelImpl. 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(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(DynamicQuery dynamicQuery,
                       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

fetchShoppingOrder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingOrder fetchShoppingOrder(long orderId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

getLatestOrder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingOrder getLatestOrder(long userId,
                                                                      long groupId)
                             throws PortalException
Throws:
PortalException

getOrder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingOrder getOrder(String number)
                       throws PortalException
Throws:
PortalException

getOrder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingOrder getOrder(long orderId)
                       throws PortalException
Throws:
PortalException

getPayPalTxnIdOrder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingOrder getPayPalTxnIdOrder(String ppTxnId)
                                  throws PortalException
Throws:
PortalException

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

getShoppingOrder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingOrder getShoppingOrder(long orderId)
                               throws PortalException
Returns the shopping order with the primary key.

Parameters:
orderId - the primary key of the shopping order
Returns:
the shopping order
Throws:
PortalException - if a shopping order with the primary key could not be found

getShoppingOrders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingOrder> getShoppingOrders(int start,
                                                                               int end)
Returns a range of all the shopping orders.

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 ShoppingOrderModelImpl. 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 shopping orders
end - the upper bound of the range of shopping orders (not inclusive)
Returns:
the range of shopping orders

getShoppingOrdersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getShoppingOrdersCount()
Returns the number of shopping orders.

Returns:
the number of shopping orders

saveLatestOrder

ShoppingOrder saveLatestOrder(ShoppingCart cart)
                              throws PortalException
Throws:
PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingOrder> search(long groupId,
                                                                    long companyId,
                                                                    long userId,
                                                                    String number,
                                                                    String billingFirstName,
                                                                    String billingLastName,
                                                                    String billingEmailAddress,
                                                                    String shippingFirstName,
                                                                    String shippingLastName,
                                                                    String shippingEmailAddress,
                                                                    String ppPaymentStatus,
                                                                    boolean andOperator,
                                                                    int start,
                                                                    int end)

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long groupId,
                                                         long companyId,
                                                         long userId,
                                                         String number,
                                                         String billingFirstName,
                                                         String billingLastName,
                                                         String billingEmailAddress,
                                                         String shippingFirstName,
                                                         String shippingLastName,
                                                         String shippingEmailAddress,
                                                         String ppPaymentStatus,
                                                         boolean andOperator)

sendEmail

void sendEmail(ShoppingOrder order,
               String emailType,
               ServiceContext serviceContext)
               throws PortalException
Throws:
PortalException

sendEmail

void sendEmail(long orderId,
               String emailType,
               ServiceContext serviceContext)
               throws PortalException
Throws:
PortalException

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

updateLatestOrder

ShoppingOrder updateLatestOrder(long userId,
                                long groupId,
                                String billingFirstName,
                                String billingLastName,
                                String billingEmailAddress,
                                String billingCompany,
                                String billingStreet,
                                String billingCity,
                                String billingState,
                                String billingZip,
                                String billingCountry,
                                String billingPhone,
                                boolean shipToBilling,
                                String shippingFirstName,
                                String shippingLastName,
                                String shippingEmailAddress,
                                String shippingCompany,
                                String shippingStreet,
                                String shippingCity,
                                String shippingState,
                                String shippingZip,
                                String shippingCountry,
                                String shippingPhone,
                                String ccName,
                                String ccType,
                                String ccNumber,
                                int ccExpMonth,
                                int ccExpYear,
                                String ccVerNumber,
                                String comments)
                                throws PortalException
Throws:
PortalException

updateOrder

ShoppingOrder updateOrder(long orderId,
                          String billingFirstName,
                          String billingLastName,
                          String billingEmailAddress,
                          String billingCompany,
                          String billingStreet,
                          String billingCity,
                          String billingState,
                          String billingZip,
                          String billingCountry,
                          String billingPhone,
                          boolean shipToBilling,
                          String shippingFirstName,
                          String shippingLastName,
                          String shippingEmailAddress,
                          String shippingCompany,
                          String shippingStreet,
                          String shippingCity,
                          String shippingState,
                          String shippingZip,
                          String shippingCountry,
                          String shippingPhone,
                          String ccName,
                          String ccType,
                          String ccNumber,
                          int ccExpMonth,
                          int ccExpYear,
                          String ccVerNumber,
                          String comments)
                          throws PortalException
Throws:
PortalException

updateOrder

ShoppingOrder updateOrder(long orderId,
                          String ppTxnId,
                          String ppPaymentStatus,
                          double ppPaymentGross,
                          String ppReceiverEmail,
                          String ppPayerEmail)
                          throws PortalException
Throws:
PortalException

updateShoppingOrder

@Indexable(type=REINDEX)
ShoppingOrder updateShoppingOrder(ShoppingOrder shoppingOrder)
Updates the shopping order in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
shoppingOrder - the shopping order
Returns:
the shopping order that was updated

Liferay 7.0-ce-m3