controls programming doc issues [was: [Fwd: [jira] Commented: (BEEHIVE-922) group of doc issues in Controls Programming document]]

[Eddie O'Neil <ek...@gmail.com>]

Steve--

  Since you've done a fair bit of work here in the past, is there any
chance that you're looking at these?  Jeremiah, can you submit patches
for these problems?

Eddie



---------- Forwarded message ----------
From: Jeremiah Johnson (JIRA) <de...@beehive.apache.org>
Date: Sep 12, 2005 4:51 PM
Subject: [jira] Commented: (BEEHIVE-922) group of doc issues in
Controls Programming document
To: dev@beehive.apache.org


    [ http://issues.apache.org/jira/browse/BEEHIVE-922?page=comments#action_12323288
]

Jeremiah Johnson commented on BEEHIVE-922:
------------------------------------------

Section 11.1 has more munged example source:

--- should be
package org.apache.beehive.controls.examples;

import org.apache.beehive.controls.api.bean.ControlExtension;

import org.apache.beehive.controls.examples.JmsMessageControl.*;

@ControlExtension
@Destination( type=DestinationType.QUEUE, name="queue.orders" )
public interface OrderQueue extends JmsMessageControl
{
    ...
}
---

Then the example below that needs some corrections and then some. 
Notice the [] in the ctor params and addition of MessageType.
--- should be
    public class Order implements java.io.Serializable {
        public Order( int buyer, String[] list ) {
            buyerID = buyer;
            itemList = list;
        }
        private int buyerID;
        private String[] itemList;
    }

    @Message( MessageType.OBJECT )
    public void submitOrder(
        @Body Order order,
        @Property(name="DeliverBy") String deliverBy
    );
---

The example in Section 11.2 needs the enums qualified
(RetentionPolicy.RUNTIME, ElementType.METHOD and param, and
MessageType.TEXT in Message), remove the javax.jms.Message import, add
the additional imports for RetentionPolicy and ElementType, and an '@'
in the Body interface.

Section 11.3 needs java.lang.reflect.Method imported.

> group of doc issues in Controls Programming document
> ----------------------------------------------------
>
>          Key: BEEHIVE-922
>          URL: http://issues.apache.org/jira/browse/BEEHIVE-922
>      Project: Beehive
>         Type: Bug
>   Components: Documentation
>     Versions: V1
>  Environment: dist built from SVN r280352
>     Reporter: Jeremiah Johnson
>     Assignee: Jeremiah Johnson
>     Priority: Minor
>      Fix For: V1

>
> There are a few errors in trunk/docs/forrest/release/src/documentation/context/xdocs/controls/programming.xml
> If this issue is assigned to me, please don't fix the document yet - I haven't finished going through it.  I decided to create this bug so I could add issues from the document as they came up.  I had created BEEHIVE-917 with a specific scope, but I see now that there are a few unrelated issues in the document so I'm creating this new bug to track everything I find (that is outside the scope of BEEHIVE-917).

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira