Implementing a use case in Java

impl = java:package.class.method;

usecases APPDUCXSAMPLE@200.200
{
  import COOSYSTEM@1.1;

  usecase CreateInvoice(out Invoice invoice) {
    variant Order {
      java = APPDUCXSAMPLE.Order.CreateInvoice;
    }
  }
}

package APPDUCXSAMPLE;

import CooLib.CooObject;
import CooLib.CooException;
import static APPDUCXSAMPLE.generated.DUCX.coort;
import static APPDUCXSAMPLE.generated.DUCX.cootx;
import APPDUCXSAMPLE.generated.DUCXImplementation;
import APPDUCXSAMPLE.generated.APPDUCXSAMPLE_200_300.actions.CreateInvoiceResult;

public class Order extends APPDUCXSAMPLE.generated.APPDUCXSAMPLE_200_300.
  classes.Order {
  public Order(CooObject obj) {
    super(obj);
  }

  @DUCXImplementation("APPDUCXSAMPLE@200.200:CreateInvoice")
  public CreateInvoiceResult CreateInvoice() throws CooException {
    CreateInvoiceResult result = new CreateInvoiceResult();
    // TODO: Auto-generated implementation stub
    return result;
  }
}

// Import for accessing component objects belonging to APPDUCXSAMPLE@200.200,
// e.g. the object representing the software component
import APPDUCXSAMPLE.generated.APPDUCXSAMPLE_200_300.APPDUCXSAMPLE_200_300;

// Import for making available object class APPDUCXSAMPLE@200.200:Invoice
import APPDUCXSAMPLE.generated.APPDUCXSAMPLE_200_300.classes.Invoice;

// Import for making available class CreateInvoiceResult for retrieving
// the output parameters after invoking the use case APPDUCXSAMPLE@200.200:
// CreateInvoice
import APPDUCXSAMPLE.generated.APPDUCXSAMPLE_200_300.actions.CreateInvoiceResult;

// Import for making available the enumeration type APPDUCXSAMPLE@200.200:
// InvoiceState
import APPDUCXSAMPLE.generated.APPDUCXSAMPLE_200_300_enums.InvoiceState;

// Import for making available the compound type APPDUCXSAMPLE@200.200:
// OrderPosition
import APPDUCXSAMPLE.generated.APPDUCXSAMPLE_200_300.structs.OrderPosition;

@DUCXImplementation("APPDUCXSAMPLE@200.200:InitializeOrder")
public void InitializeOrder(final Person customer) throws CooException {
  // Lock the order object
  this.COOSYSTEM_1_1_ObjectLock(true, true, null, null);

  // Initialize order date with current date and set order status to
  // OS_PENDING
  this.APPDUCXSAMPLE_200_300_orderdate = new Date();
  this.APPDUCXSAMPLE_200_300_orderstate = OrderState.OS_PENDING;

  // Set express delivery for wholesalers
  if (customer.APPDUCXSAMPLE_200_300_customertype == CustomerType.
    CT_WHOLESALER) {
    this.APPDUCXSAMPLE_200_300_orderdelivery = DeliveryType.DT_EXPRESS;
  }
  else {
    this.APPDUCXSAMPLE_200_300_orderdelivery = DeliveryType.DT_STANDARD;
  }

  // Add the order to the customer's list of orders
  this.COODESK_1_1_ShareObject(null, null, APPDUCXSAMPLE_200_300.
    getProperty_customerorders(), customer);
}

app.ducx Use Case Language

usecase AddPositionToOrder(Product product, integer quantity) {
  variant Order {
    impl = java:APPDUCXSAMPLE.Order.AddPositionToOrder;
  }
}

Java Implementation

@DUCXImplementation("APPDUCXSAMPLE@200.200:AddPositionToOrder")
public void AddPositionToOrder(final Product product, final Long
  quantity) throws CooException {
  // Lock the order
  this.COOSYSTEM_1_1_ObjectLock(true, true, null, null);

  // Create a new order position
  OrderPosition position = OrderPosition.create();
  position.APPDUCXSAMPLE_200_300_product = product;
  position.APPDUCXSAMPLE_200_300_quantity = quantity;

  // Add the new order position to the order
  List<OrderPosition> positions = this.APPDUCXSAMPLE_200_300_orderpositions;
  positions.add(position);
  this.APPDUCXSAMPLE_200_300_orderpositions = positions;
}

app.ducx Use Case Language

usecase GetCustomerOrders(out Order[] orders) {
  variant Person {
    impl = java:APPDUCXSAMPLE.Person.GetCustomerOrders;
  }
}

Java Implementation

@DUCXImplementation("APPDUCXSAMPLE@200.200:GetCustomerOrders")
public GetCustomerOrdersResult GetCustomerOrders() throws CooException {
  // Output parameters must be passed back using the result object
  GetCustomerOrdersResult result = new GetCustomerOrdersResult();

  // The sort order is determined by a list of property definitions
  ArrayList<Object> sortorder = new ArrayList<Object>();
  sortorder.add(APPDUCXSAMPLE_200_300.getProperty_orderdate());

  // Sort the customer's list of orders (the sorted list is returned in
  // the valuelist member variable of the SortResult object)
  SortResult sortresult = this.COOATTREDIT_1_1_Sort(
    this.APPDUCXSAMPLE_200_300_customerorders, true, sortorder, null);

  // Return the sorted list of orders
  result.orders = sortresult.valuelist;
  return result;
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:MarkOrderAsShipped")
public void MarkOrderAsShipped() throws CooException {
  // Lock the order object
  this.COOSYSTEM_1_1_ObjectLock(true, true, null, null);

  // Create a new instance of object class APPDUCXSAMPLE@200.200:Invoice
  Invoice invoice = Invoice.create();

  // Reference the new invoice object in the order object and set
  // the order's state to OS_SHIPPED
  this.APPDUCXSAMPLE_200_300_orderinvoice = invoice;
  this.APPDUCXSAMPLE_200_300_orderstate = OrderState.OS_SHIPPED;
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:ProcessPendingOrders")
public void AddOrderCategory(final Case case) throws CooException {
  ComponentDocumentCategory category = this.COOTC_1_1001_objcategory;
  List<Object> casecategories = case.COOTC_1_1001_allowedcategories;

  // Check whether APPDUCXSAMPLE@200.200:DocumentCategoryOrder was selected
  // for the order object
  if (category.equals(APPDUCXSAMPLE_200_300.getClass_DocumentCategoryOrder())) {
    if (!casecategories.contains(APPDUCXSAMPLE_200_300.
      getClass_DocumentCategoryOrder())) {
      ComponentDocumentCategory.from(APPDUCXSAMPLE_200_300.
        get_DocumentCategoryOrder()).COODESK_1_1_ShareObject(null, null,
        COOTC_1_1001.getProperty_allowedcategories(), case);
    }
    else {
      coort.SetError(APPDUCXSAMPLE_200_300.
      getErrorMessage_CategoryAlreadyAdded());
    }
  }
  else {
    coort.SetError(APPDUCXSAMPLE_200_300.
    getErrorMessage_UnexpectedOrderCategory());
  }
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:ArchiveOrder")
public void ArchiveOrder() throws CooException {
  if (this.APPDUCXSAMPLE_200_300_orderstate == OrderState.OS_COMPLETED) {
    // Lock the order object and set the order state to OS_ARCHIVED
    this.COOSYSTEM_1_1_ObjectLock(true, true, null, null);
    this.APPDUCXSAMPLE_200_300_orderstate = OrderState.OS_ARCHIVED;

    // Invoke an XML web service to archive the order
    archiveOrderXML();
  }
  else {
    // Raise an error if the order is not completed yet
    coort.SetError(APPDUCXSAMPLE_200_300.getErrorMessage_InvalidOrderState());
  }
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:AddPositionToOrder")
public void AddPositionToOrder(final Product product,
  final Long quantity) throws CooException {
  // Lock the order object
  this.COOSYSTEM_1_1_ObjectLock(true, true, null, null);

  // Retrieve the existing order positions
  List<OrderPosition> positions = this.APPDUCXSAMPLE_200_300_orderpositions;

  // Create a new entry and add it to the list of existing order positions
  OrderPosition position = OrderPosition.create();
  position.APPDUCXSAMPLE_200_300_product = product;
  position.APPDUCXSAMPLE_200_300_quantity = quantity;
  positions.add(position);

  // Write the modified list of order positions back to the order
  this.APPDUCXSAMPLE_200_300_orderpositions = positions;
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:SendProductDescription")
public void SendProductDescription() throws CooException {
  // Get the product description as a scalar string value
  // Note: this.APPDUCXSAMPLE_200_300_productdescription returns a List<String>
  String description = this.GetAttributeString(cootx, APPDUCXSAMPLE_200_300.
    getProperty_productdescription(), null, CooFlags.COODISP_ROWLIST);

  // Store the description string in a content
  CooContent descriptioncontent = coort.CreateContent();
  descriptioncontent.SetContent(cootx, CooFlags.COOGC_MULTIBYTEFILE,
    CooFlags.COOGC_UTF8, description);

  // Create a structure of compound type COOSYSTEM@1.1:Content and
  // store the content in this structure
  Content content = Content.create();
  content.COOSYSTEM_1_1_contcontent = descriptioncontent;
  content.COOSYSTEM_1_1_contextension = "txt";

  // Invoke an XML web service to transmit the content
  sendProductDescriptionXML(content);
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:ValidateInvoice")
public void ValidateInvoice() throws CooException {
  Invoice invoice = this;
  Date paymentdate = invoice.APPDUCXSAMPLE_200_300_invoicepaymentdate;
  InvoiceState invoicestate = invoice.APPDUCXSAMPLE_200_300_invoicestate;
  String expressiontext = getValidationExpression(invoice);

  // Create and populate global scope dictionary
  CooDictionary globalscope = coort.CreateDictionary();
  globalscope.SetEntryValue("paydate", paymentdate);
  globalscope.SetEntryValue("state", invoicestate);

  // Evaluate validation expression and get result
  CooValue[] result = CooExpression.Evaluate(cootx, expressiontext,
    CooValue.asArray(globalscope), CooValue.asArray(invoice));

  if (result[0].getBool().getValue()) {
    // Validation expression returned "true"
    processInvoice(invoice);
  }
  else {
    // Validation expression returned "false"
    coort.SetError(APPDUCXSAMPLE_200_300.getErrorMessage_ValidationError());
  }
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:ProcessPendingOrders")
public void ProcessPendingOrders() throws CooException {
  // Get the pending orders of the current user
  User user = (User) coort.GetCurrentUser();
  List<Order> pendinglist = user.APPDUCXSAMPLE_200_300_pendingorders;

  // Trace the number of pending orders
  coort.Trace("Found " + pendinglist.size() + " pending orders");

  // Load all properties of the pending order objects
  Order[] orders = pendingList.toArray(new Order[pendinglist.size()]);
  coort.LoadAllAttributes(cootx, orders);

  processPendingOrders(orders);
}

@DUCXImplementation("COOSYSTEM@1.1:ObjectPrepareCommit")
public void InvoicePrepareCommit(final Boolean internalchange)
  throws CooException {
  // Check if the invoice has been created in the current transaction
  // and if property APPDUCXSAMPLE@200.200:invoicestate has been changed
  if (!cootx.IsCreated(this) && cootx.IsAttributeChanged(this,
    APPDUCXSAMPLE_200_300.getProperty_invoicestate())) {
    // Rebuild the object's name based on the name build configuration
    this.FSCCONFIG_1_1001_ObjectPrepareCommitNameBuild();
  }
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:CreateInvoice")
public void CreateInvoice() throws CooException {
  // Create a new transaction
  CooTransaction backuptx = DUCX.cootx;
  CooTransaction localtx = new CooTransaction();

  try {
    // Perform the following operations in context of the new transaction
    coort.SetThreadTransaction(localtx);
    Invoice invoice = Invoice.create();
    this.APPDUCXSAMPLE_200_300_InitializeInvoice(invoice);
    // Commit the changes
    localtx.Commit();
  }
  catch (Exception ex) {
    // In case of an error, roll back the changes
    localtx.Abort();
  }
  finally {
    // Restore original transaction context
    coort.SetThreadTransaction(backuptx);
    // Clear the variables holding the transactions
    backuptx = null;
    localtx = null;
  }
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:ReleaseOrder")
public void ReleaseOrder() throws CooException {
  // Get the order object from transaction variable 1 of COOWF@1.1
  Order order = Order.from(cootx.GetVariableValue(COOWF_1_1.
    getSoftwareComponent(), 1).getObject());

  // Determine if batch mode is enabled by checking transaction
  // variable TV_BATCHMODE of COOSYSTEM@1.1
  Boolean batchmode = COOSYSTEM_1_1.getTransactionVariables_TV().
    COOSYSTEM_1_1_TV_BATCHMODE;

  if (order != null && !batchmode) {
    releaseOrder(order);
  }
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:ProcessOrder")
public void ProcessOrder() throws CooException {
  if (processOrder(this)) {
    Invoice invoice = this.APPDUCXSAMPLE_200_300_orderinvoice;
    Boolean printinvoice = invoice.APPDUCXSAMPLE_200_300_invoicestate ==
      InvoiceState.IS_PENDING;

    // Set transaction variables TV_PRINTINVOICE and TV_INVOICE of
    // APPDUCXSAMPLE@200.200
    COOSYSTEM_1_1.getTransactionVariables_TV().
      APPDUCXSAMPLE_200_300_TV_PRINTINVOICE = printinvoice;
    COOSYSTEM_1_1.getTransactionVariables_TV().
      APPDUCXSAMPLE_200_300_TV_INVOICE = invoice;
  }
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:ShipOrder")
public void ShipOrder() throws CooException {
  // Retrieve and evaluate transaction variable TV_PRINTINVOICE of
  // APPDUCXSAMPLE@200.200
  Boolean printinvoice = COOSYSTEM_1_1.getTransactionVariables_TV().
    APPDUCXSAMPLE_200_300_TV_PRINTINVOICE

  if (printinvoice) {
    Invoice invoice = COOSYSTEM_1_1.getTransactionVariables_TV().
      APPDUCXSAMPLE_200_300_TV_INVOICE;
    invoice.APPDUCXSAMPLE_200_300_SendInvoice();
  }

  shipOrder(this);
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:SendInvoice")
public void SendInvoice() throws CooException {
  Invoice invoice = this;
  Order order = invoice.APPDUCXSAMPLE_200_300_invoiceorder;
  ContactPerson customer = order.APPDUCXSAMPLE_200_300_ordercustomer;
  CooContent mailbodycontent = coort.CreateContent();

  // Create and populate global scope dictionary
  CooDictionary globalscope = coort.CreateDictionary();
  globalscope.SetEntryValue("invoice", invoice);
  globalscope.SetEntryValue("order", order);
  globalscope.SetEntryValue("customer", customer);

  // Make available the values stored in the global scope dictionary
  // when the invoice report is evaluated by initializing transaction
  // variable 1 of COOAR@1.1
  cootx.SetVariableValue(COOAR_1_1.getSoftwareComponent(), 1,
    DUCX.getTypeDictionary(), globalscope);

  // Evaluate the invoice report template to get the HTML mail body
  CreateReportResult reportresult = invoice.COOAR_1_1_CreateReport(
    APPDUCXSAMPLE_200_300.getClass_InvoiceTemplateReport(), false, null, null,
    mailbodycontent);

  mailbodycontent = reportresult.resultcontent;

  if (mailbodycontent != null) {
    Addressee mainaddress = customer.FSCFOLIO_1_1001_mainaddress;
    String recipient = mainaddress.FSCFOLIO_1_1001_emailaddress;
    String sender = "orderprocessing@APPDUCXSAMPLE.fabasoft.com";
    String subject = invoice.GetName();
    ArrayList<String> recipients = new ArrayList<String>();
    recipients.add(recipient);
    ArrayList<CooContent> mailbody = new ArrayList<CooContent>();
    mailbody.add(mailbodycontent);
    %%TRACE("Mail Recipient:", recipient);
    %%TRACE("Mail Subject:", subject);
    %%TRACE("Mail Body:", mailbodycontent.GetContent(cootx,
      CooFlags.COOGC_MULTIBYTEFILE, CooFlags.COOGC_UTF8));
    // Send the invoice mail to the customer
    invoice.FSCSMTP_1_1001_SendHTML(sender, recipients, subject, mailbody,
      null, null, null, null, null, null, null);
  }
}

@DUCXImplementation("APPDUCXSAMPLE@200.200:ProcessPendingOrders")
public void ProcessPendingOrders() throws CooException {
  DUCX.traceEnter();

  // Get the pending orders of the current user
  User user = (User) coort.GetCurrentUser();
  List<Order> pendinglist = user.APPDUCXSAMPLE_200_300_pendingorders;

  // Trace the list of pending orders
  DUCX.trace("List of Orders:", pendinglist);

  // Load all properties of the pending order objects
  Order[] orders = pendingList.toArray(new Order[pendinglist.size()]);
  coort.LoadAllAttributes(cootx, orders);

  processPendingOrders(orders);
  DUCX.traceLeave();
}

public List<ActionParameterList> GetNameBuildInParameters() throws CooException {
  //Get the type of the customization point
  TypeCustomizationPointDef cptdef = FSCCONFIG_1_1001.getCPT_NameBuild();
  //Return customization point parameters
  List<ActionParameterList> parameters = tcpt.COOSYSTEM_1_1_typecpparameters;
  ...
  return inparameters;
}