[jira] [Comment Edited] (OFBIZ-11963) Checkstyle: Variable must be private and have accessor methods

[Nicolas Malin (Jira)]

    [ https://issues.apache.org/jira/browse/OFBIZ-11963?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17182251#comment-17182251 ]

Jacques Le Roux edited comment on OFBIZ-11963 at 8/22/20, 6:34 AM:
-------------------------------------------------------------------

BTW, I have aligned names and descriptions. So get something like

{code:java}
/**
 * Determines commission receiving parties and amounts for the provided product, price, and quantity
 * @param ctx The DispatchContext that this service is operating in.
 * @param context Map containing the input parameters. productId String Product Id invoiceItemTypeId String Invoice Type amount BigDecimal Entire
 * amount quantity BigDecimal Quantity
 * @return Map with the result of the service, the output parameters. commissions List List of Maps each containing partyIdFrom String
 * commission paying party partyIdTo String commission receiving party commission BigDecimal Commission days Long term days
 * currencyUomId String Currency productId String Product Id
 */
 public static Map<String, Object> getCommissionForProduct(DispatchContext ctx, Map<String, Object> context) { 
{code}

instead of currently

{code:java}
    /**
     * Determines commission receiving parties and amounts for the provided product, price, and quantity
     * @param ctx The DispatchContext that this service is operating in.
     * @param context Map containing the input parameters.
     *      productId   String      Product Id
     *      invoiceItemTypeId   String      Invoice Type
     *      amount      BigDecimal  Entire amount
     *      quantity    BigDecimal  Quantity
     * @return Map with the result of the service, the output parameters.
     *      commissions List        List of Maps each containing
     *              partyIdFrom     String  commission paying party
     *              partyIdTo       String  commission receiving party
     *              commission      BigDecimal  Commission
     *              days            Long    term days
     *              currencyUomId   String  Currency
     *              productId       String  Product Id
     */
{code}

Not sure it's better in complex cases like above...


was (Author: jacques.le.roux):
BTW, I have aligned names and descriptions. So get something like

{code:java}
/**
 * Determines commission receiving parties and amounts for the provided product, price, and quantity
 * @param ctx The DispatchContext that this service is operating in.
 * @param context Map containing the input parameters. productId String Product Id invoiceItemTypeId String Invoice Type amount BigDecimal Entire
 * amount quantity BigDecimal Quantity
 * @return Map with the result of the service, the output parameters. commissions List List of Maps each containing partyIdFrom String
 * commission paying party partyIdTo String commission receiving party commission BigDecimal Commission days Long term days
 * currencyUomId String Currency productId String Product Id
 */
 public static Map<String, Object> getCommissionForProduct(DispatchContext ctx, Map<String, Object> context) { 
{code}

instead of currently

{code:java}
    /**
     * Determines commission receiving parties and amounts for the provided product, price, and quantity
     * @param ctx The DispatchContext that this service is operating in.
     * @param context Map containing the input parameters.
     *      productId   String      Product Id
     *      invoiceItemTypeId   String      Invoice Type
     *      amount      BigDecimal  Entire amount
     *      quantity    BigDecimal  Quantity
     * @return Map with the result of the service, the output parameters.
     *      commissions List        List of Maps each containing
     *              partyIdFrom     String  commission paying party
     *              partyIdTo       String  commission receiving party
     *              commission      BigDecimal  Commission
     *              days            Long    term days
     *              currencyUomId   String  Currency
     *              productId       String  Product Id
     */
{code}

> Checkstyle: Variable must be private and have accessor methods
> --------------------------------------------------------------
>
>                 Key: OFBIZ-11963
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-11963
>             Project: OFBiz
>          Issue Type: Sub-task
>          Components: ALL COMPONENTS
>    Affects Versions: Trunk
>            Reporter: Suraj Khurana
>            Assignee: Suraj Khurana
>            Priority: Major
>         Attachments: OFBIZ-11963-plugins.patch, OFBIZ-11963.patch, Screenshot 2020-08-20 at 5.42.17 PM.png
>
>

--
This message was sent by Atlassian Jira
(v8.3.4#803005)