Details in the sequence diagrams...

[James Turner]

Hi Guys,

I have been thinking about the amount of detail I show in the sequence diagrams, is is common to show all the various parameters and return values for each method call? Do we need to show things like any VO's we use?

Does anyone show this level of detail in the sequence diagram? So far I have only specified the method calls, nothing more.

Thank you for any help.

Regards,
James.

[Erik Brakkee]

Hi,


What I am doing is to include a section on the UML modeling conventions I use. This is basically a collection of how I model many situations in a simplified form. Since the complete form can always be derived straight from the simplified form, I can simplify the modeling in the sequence diagrams.

As far as call and return parameters are concerned, I am using names whereever appropriate, for instance to show that the result of one call is input to another call I name the return and call parameters. I just show enough to understand the general concept.

Also, I include text to explain the sequence diagrams. I am assuming that those people who are grading the exams are sensible people.

Cheers
Erik

[Lekha Sharma]

I dont think one has to go that level of detail. Alternatively, you can give appropriate names to the messages and add notes whereever it is necessary to clarify the meaning.

One thing you can do is, add method parameters(VOs), return values to the client call to business tier and add notes saying that same VO are used in buseinss tier calls.

[Parag Bharambe]

Hi,

I am wondering how much detail should be mentioned in seq diagram.

Support you are creating SeatVO.

It will be
For each Intinerary
For each return and departure journey
for each segment
create seat DTO.

this loop will be repeated for lot of places in seq diagram.

Do I need to show all this in method call in seq diagram or mentioing it in Notes will suffice?

Parag

[Santiago Urrizola]

Originally posted by Parag Bharambe:

Do I need to show all this in method call in seq diagram or mentioing it in Notes will suffice?
Parag

for me, yes will be suffice, the idea of sequence diagram is to represent what are the responsabilities of each class ... i think creation of VOs as details of implementation .. just mention in notes ... its my idea ..I am doing it of that way. I dont explicitly mention in the sequence diagram the creation of VOs or DTOs.

and a question ... VOs = DTOs for you ?