Hi,

Here is the comment I wrote.
/**
 * This is a classic sample of DTOs.
 * An instance of this class can represent either an user item or role item.
 * This is used to represent items in lists of users and roles sent to the
Carbon FE.
 * It contains information to indicate whether the representing item is
editable
 * or selected within the given context.
 */

Here are the use cases.

Usecase 1 : When listing roles we should not show the editable link if it is
a external role.

Before FlaggedName
1) Send the complete role list (hybrid + external) to FE
2) Send the role list that are external to FE

When listing roles in FE go through both lists, and do not show edit links
for external roles. This logic in JSPs could not be reused. Idea was to cut
down the number of calls. It was a feedback given  in a review.

After FlaggedNames
1) Send the list of FlaggedNames

Usecase 2 :  When user clicks on edit users of a Role

Before FlaggedName
1) Send the list of users that are already in the role so that I can show
the ticks in the GUI
2) Send the complete requested user list to FE (selected by *) so I can show
them unchecked

After FlaggedName
1)Cut down the nubmer of calls going back and forth

And many more to continue ..... And since I wrote two use cases I will
include them also in the comment. :)

Thanks,
Dimuthu

On Sat, Mar 12, 2011 at 9:51 PM, Paul Fremantle <[email protected]> wrote:

> And can you let us know what it is here? I'm all agog.
>
> Thx!
> Paul
>
>
> On 12 March 2011 15:52, Dimuthu Leelarathne <[email protected]> wrote:
>
>> Hi,
>>
>> My fault. I added it long time ago - maybe 2 years ago. I should have
>> added  a comment.
>>
>> I will do that right now.
>>
>> Thanks,
>> Dimuthu
>>
>> On Sat, Mar 12, 2011 at 7:10 PM, Afkham Azeez <[email protected]> wrote:
>>
>>> org.wso2.carbon.user.mgt.common.FlaggedName
>>>
>>> I wouldn't have to ask if the author took 2 seconds to write a one line
>>> comment !!!
>>>
>>> So, once again people have stopped commenting their APIs, and given up on
>>> best practices (FindBugs etc.)?
>>>
>>> --
>>> *Afkham Azeez*
>>> Senior Software Architect & Senior Manager; WSO2, Inc.; http://wso2.com
>>> ,
>>> *
>>> *
>>> *Member; Apache Software Foundation; 
>>> **http://www.apache.org/*<http://www.apache.org/>
>>> *
>>> email: **[email protected]* <[email protected]>* cell: <%2B94%2077%203320919>+94
>>> 77 3320919
>>> blog: **http://blog.afkham.org* <http://blog.afkham.org>*
>>> twitter: **http://twitter.com/afkham_azeez*<http://twitter.com/afkham_azeez>
>>> *
>>> linked-in: **http://lk.linkedin.com/in/afkhamazeez*
>>> *
>>> *
>>> *Lean . Enterprise . Middleware*
>>>
>>>
>>> _______________________________________________
>>> Carbon-dev mailing list
>>> [email protected]
>>> http://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev
>>>
>>>
>>
>> _______________________________________________
>> Carbon-dev mailing list
>> [email protected]
>> http://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev
>>
>>
>
>
> --
> Paul Fremantle
> CTO and Co-Founder, WSO2
> OASIS WS-RX TC Co-chair, VP, Apache Synapse
>
> Office: +44 844 484 8143
> Cell: +44 798 447 4618
>
> blog: http://pzf.fremantle.org
> twitter.com/pzfreo
> [email protected]
>
> wso2.com Lean Enterprise Middleware
>
> Disclaimer: This communication may contain privileged or other confidential
> information and is intended exclusively for the addressee/s. If you are not
> the intended recipient/s, or believe that you may have received this
> communication in error, please reply to the sender indicating that fact and
> delete the copy you received and in addition, you should not print, copy,
> retransmit, disseminate, or otherwise use the information contained in this
> communication. Internet communications cannot be guaranteed to be timely,
> secure, error or virus-free. The sender does not accept liability for any
> errors or omissions.
>
_______________________________________________
Carbon-dev mailing list
[email protected]
http://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev

Reply via email to