POJO Service Engine - Revision history

Sichen: /* POJO Service Engine */

2008-08-21T21:38:24Z

‎POJO Service Engine

Sichen: /* POJO Service Engine */

2008-08-21T21:34:41Z

‎POJO Service Engine

Sichen at 21:12, 21 August 2008

2008-08-21T21:12:36Z

Sichen: /* POJO Service Engine */

2008-07-11T21:45:09Z

‎POJO Service Engine

Sichen: /* POJO Service Engine */

2008-07-09T22:00:34Z

‎POJO Service Engine

Sichen: Protected "POJO Service Engine": Sysop page [edit=sysop:move=sysop]

2008-07-09T21:57:29Z

Protected "POJO Service Engine": Sysop page [edit=sysop:move=sysop]

Sichen: New page: ==POJO Service Engine== The POJO service engine is designed to allow you to mount your Java service objects directly on to the ofbiz service engine, without having to write a static Java ...

2008-07-09T21:57:24Z

New page: ==POJO Service Engine== The POJO service engine is designed to allow you to mount your Java service objects directly on to the ofbiz service engine, without having to write a static Java ...

New page

==POJO Service Engine==

The POJO service engine is designed to allow you to mount your Java service objects directly on to the ofbiz service engine, without having to write a static Java method to call it. To use the POJO service engine, you have to declare your service with service engine XML file, just like for all of the other ofbiz services, but use <tt>pojo</tt> instead of <tt>java</tt> as the engine:

Then, you could write your [[Domain Driven Architecture#Services|service]] as a Java class with the following requirements:
# It must extend the base <tt>org.opentaps.foundation.service.ofbiz.Service</tt> class
# You must have a default constructor which takes no parameters
# For each input parameter defined in your services XML, you must have a set method. The set method must be named "set" plus the name of the variable, with the first letter capitalized. For example, if you have "orderId" as an input parameter of your service, you must have a "setOrderId" method. It can not be "SetOrderId", "setorderid", or "setorderId". This is done intentionally to enforce code consistency.
# Each set method must take one parameter, and it must match the parameter in your services XML. For example, if your services XML specifies "java.util.List", your set method take a single parameter of the java.util.List class, not ArrayList, FastList, LinkedList, etc.
# For each output parameter defined in your services XML, you must define one get method which takes no parameters. The name of the get method must be "get" plus the name of the variable with the first letter capitalized (ie, "getInvoiceId()" for "invoiceId").
# The invoke method must be a void method with no parameters.
# Instead of returning <tt>ServiceUtil.returnError</tt> when there is a problem with the service, throw [[Domain Driven Architecture#Exceptions|exceptions]] such as <tt>ServiceException</tt>

@@ Line 28: / Line 28: @@
 Within the service, you can:
 * access other domains of the [[Domain Driven Architecture]] using the <tt>getDomainsDirectory()</tt> method of the Service superclass.
-* get the ofbiz framework's delegator and dispatcher through the [[Domain Driven Architecture#Infrastructure]] with the getInfrastructure() method, then calling getDelegator() and getDispatcher()
+* get the ofbiz framework's delegator and dispatcher through the [[Domain Driven Architecture#Infrastructure|Infrastructure]] with the getInfrastructure() method, then calling getDelegator() and getDispatcher()
 * get a UserLogin GenericValue for running legacy services written in the ofbiz framework  by getting the User object from the getUser() method, then calling its getOfbizUserLogin() method

@@ Line 5: / Line 5: @@
 <pre>
     <service name="opentaps.invoiceNonPhysicalOrderItems" engine="pojo"
-         location="com.opensourcestrategies.financials.invoice.OrderInvoicingService" invoke="invoiceNonPhysicalOrderItems">
+         location="org.opentaps.financials.domain.billing.invoice.OrderInvoicingService" invoke="invoiceNonPhysicalOrderItems">
          <description>Creates an invoice from the non-physical items on the order.  It will invoice from the status in the orderItemStatusId,
          or if it is not supplied, default to ITEM_PERFORMED.  After the invoice is created, it will attempt to change the items' status
@@ Line 33: / Line 33: @@
 Here is a complete example:
 <pre>
 public class OrderInvoicingService extends Service {
      private static final String module = OrderInvoicingService.class.getName();
@@ Line 73: / Line 74: @@
          try {
              // validate that the order actually exists and get list of non-physical
-             OrderRepository orderRepository = new OrderRepository(new Infrastructure(dispatcher), user);
+             OrderDomainInterface orderDomain = getDomainsDirectory().getOrderDomain();
              Order order = orderRepository.getOrderById(orderId);
-             List<GenericValue> itemsToInvoice = order.getNonPhysicalItemsForStatus(statusIdForNonPhysicalItemsToInvoice);
+             List<OrderItem> itemsToInvoice = order.getNonPhysicalItemsForStatus(statusIdForNonPhysicalItemsToInvoice);
              // check if there are items to invoice
@@ Line 84: / Line 87: @@
              // create a new invoice for the order items
              // because of the way createInvoiceForOrder is written (665 lines of code!) we'd have to do some re-factoring before we can add the items to an existing invoice
-             Map tmpResult = getDispatcher().runSync("createInvoiceForOrder", UtilMisc.toMap("orderId", orderId, "billItems", itemsToInvoice, "userLogin", user), 7200, false);  // no new transaction
+             Map tmpResult = getInfrastructure().getDispatcher().runSync("createInvoiceForOrder", UtilMisc.toMap("orderId", orderId, "billItems", Repository.genericValueFromEntity(getInfrastructure().getDelegator(), "OrderItem", itemsToInvoice), "userLogin", getUser().getOfbizUserLogin()), 7200, false);  // no new transaction
              if (ServiceUtil.isError(tmpResult)) {
                  throw new ServiceException(ServiceUtil.getErrorMessage(tmpResult));

← Older revision		Revision as of 21:12, 21 August 2008
Line 25:		Line 25:

	You can define more than one service inside the same Java class by using different void methods without parameters. The same Java class should be shared among services that have similar input and output parameters.		You can define more than one service inside the same Java class by using different void methods without parameters. The same Java class should be shared among services that have similar input and output parameters.
		+
		+	Within the service, you can:
		+	* access other domains of the [[Domain Driven Architecture]] using the <tt>getDomainsDirectory()</tt> method of the Service superclass.
		+	* get the ofbiz framework's delegator and dispatcher through the [[Domain Driven Architecture#Infrastructure]] with the getInfrastructure() method, then calling getDelegator() and getDispatcher()
		+	* get a UserLogin GenericValue for running legacy services written in the ofbiz framework by getting the User object from the getUser() method, then calling its getOfbizUserLogin() method

	Here is a complete example:		Here is a complete example:

@@ Line 23: / Line 23: @@
 # The invoke method must be a void method with no parameters.
 # Instead of returning <tt>ServiceUtil.returnError</tt> when there is a problem with the service, throw [[Domain Driven Architecture#Exceptions|exceptions]] such as <tt>ServiceException</tt>
 Here is a complete example:

@@ Line 2: / Line 2: @@
 The POJO service engine is designed to allow you to mount your Java service objects directly on to the ofbiz service engine, without having to write a static Java method to call it.  To use the POJO service engine, you have to declare your service with service engine  XML file, just like for all of the other ofbiz services, but use <tt>pojo</tt> instead of <tt>java</tt> as the engine:
 Then, you could write your [[Domain Driven Architecture#Services|service]] as a Java class with the following requirements:
@@ Line 11: / Line 23: @@
 # The invoke method must be a void method with no parameters.
 # Instead of returning <tt>ServiceUtil.returnError</tt> when there is a problem with the service, throw [[Domain Driven Architecture#Exceptions|exceptions]] such as <tt>ServiceException</tt>

← Older revision	Revision as of 21:57, 9 July 2008
(No difference)