Liferay 6.2.0

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
abstract  ShoppingOrder addLatestOrder(long userId, long groupId)
           
abstract  ShoppingOrder addShoppingOrder(ShoppingOrder shoppingOrder)
          Adds the shopping order to the database.
abstract  void completeOrder(String number, String ppTxnId, String ppPaymentStatus, double ppPaymentGross, String ppReceiverEmail, String ppPayerEmail, boolean updateInventory, ServiceContext serviceContext)
           
abstract  ShoppingOrder createShoppingOrder(long orderId)
          Creates a new shopping order with the primary key.
abstract  void deleteOrder(long orderId)
           
abstract  void deleteOrder(ShoppingOrder order)
           
abstract  void deleteOrders(long groupId)
           
abstract  ShoppingOrder deleteShoppingOrder(long orderId)
          Deletes the shopping order with the primary key from the database.
abstract  ShoppingOrder deleteShoppingOrder(ShoppingOrder shoppingOrder)
          Deletes the shopping order from the database.
abstract  DynamicQuery dynamicQuery()
           
abstract  List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
abstract  List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
abstract  List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
abstract  long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
abstract  long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
abstract  ShoppingOrder fetchShoppingOrder(long orderId)
           
abstract  String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
abstract  ShoppingOrder getLatestOrder(long userId, long groupId)
           
abstract  ShoppingOrder getOrder(long orderId)
           
abstract  ShoppingOrder getOrder(String number)
           
abstract  ShoppingOrder getPayPalTxnIdOrder(String ppTxnId)
           
abstract  PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
abstract  ShoppingOrder getShoppingOrder(long orderId)
          Returns the shopping order with the primary key.
abstract  List<ShoppingOrder> getShoppingOrders(int start, int end)
          Returns a range of all the shopping orders.
abstract  int getShoppingOrdersCount()
          Returns the number of shopping orders.
abstract  ShoppingOrder saveLatestOrder(ShoppingCart cart)
           
abstract  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)
           
abstract  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)
           
abstract  void sendEmail(long orderId, String emailType, ServiceContext serviceContext)
           
abstract  void sendEmail(ShoppingOrder order, String emailType, ServiceContext serviceContext)
           
abstract  void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
abstract  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)
           
abstract  ShoppingOrder updateOrder(long orderId, String ppTxnId, String ppPaymentStatus, double ppPaymentGross, String ppReceiverEmail, String ppPayerEmail)
           
abstract  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)
           
abstract  ShoppingOrder updateShoppingOrder(ShoppingOrder shoppingOrder)
          Updates the shopping order in the database or adds it if it does not yet exist.
 

Method Detail

addShoppingOrder

@Indexable(type=REINDEX)
ShoppingOrder addShoppingOrder(ShoppingOrder shoppingOrder)
                               throws SystemException
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
Throws:
SystemException - if a system exception occurred

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

deleteShoppingOrder

@Indexable(type=DELETE)
ShoppingOrder deleteShoppingOrder(long orderId)
                                  throws PortalException,
                                         SystemException
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
SystemException - if a system exception occurred

deleteShoppingOrder

@Indexable(type=DELETE)
ShoppingOrder deleteShoppingOrder(ShoppingOrder shoppingOrder)
                                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchShoppingOrder

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

getShoppingOrder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingOrder getShoppingOrder(long orderId)
                               throws PortalException,
                                      SystemException
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
SystemException - if a system exception occurred

getPersistedModel

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

getShoppingOrders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingOrder> getShoppingOrders(int start,
                                                                               int end)
                                      throws SystemException
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
Throws:
SystemException - if a system exception occurred

getShoppingOrdersCount

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

Returns:
the number of shopping orders
Throws:
SystemException - if a system exception occurred

updateShoppingOrder

@Indexable(type=REINDEX)
ShoppingOrder updateShoppingOrder(ShoppingOrder shoppingOrder)
                                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addLatestOrder

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

completeOrder

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

deleteOrder

void deleteOrder(long orderId)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteOrder

void deleteOrder(ShoppingOrder order)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteOrders

void deleteOrders(long groupId)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

getLatestOrder

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

getOrder

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

getOrder

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

getPayPalTxnIdOrder

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

saveLatestOrder

ShoppingOrder saveLatestOrder(ShoppingCart cart)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

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)
                           throws SystemException
Throws:
SystemException

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)
                throws SystemException
Throws:
SystemException

sendEmail

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

sendEmail

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

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,
                                       SystemException
Throws:
PortalException
SystemException

updateOrder

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

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,
                                 SystemException
Throws:
PortalException
SystemException

Liferay 6.2.0