Wiki
This website is a wiki. If you like and use our processes, techniques and tools, please add your experience and best practices. Just register and share.

Contents


User


Smart


Community

Forum






A Search type of use case represents the functionality for searching a single item from a list of business objects from one class, with the added functionality of filtering on one or more property values of associated classes. For example, selecting a service contract from all service contracts of a particular service engineer in a particular region. Typically this type of use case functionality requires joining and unioning multiple collections of business objects of different classes. If these classes are directly associated with each other, this stereotype applies. If these classes are not directly associated it is advised to use the Extended Search stereotype instead.

Preconditions

-none-

Steps

A Search performs the following basic steps.
  • Start. The system initiates the use case.
  • Show query criteria. The system presents the form with the query criteria.
  • Enter criteria values. The user enters the values for the query criteria.
  • Get items. The system gets the items for which the query criteria apply.
  • Show items. The system presents the form (any type, such as a web page, a Windows form, a Flash form) and shows the search criteria and values and the list of items for which these values apply.
  • Select item. The user selects a single item from the list.
    • Alternative flow - Cancel:
      1. The user selects the action Cancel.
      2. Finish. The system finishes the use case without passing back an item.
    • Alternative flow - New:
      1. The user selects the action New.
      2. Finish. The system finishes the use case by passing back a new item with default property values
  • Finish. The system finishes the use case by passing back the selected item.

Postconditions

  1. A single instance of a business object is returned
  2. The use case is canceled by the user
These conditions are XOR

Characteristics

A Search follows the following characteristics:
  • Form. Form to the display the Query and List panels. Can be any type of form.
  • Query. Panel to display the query criteria.
  • List. Panel to display the List of items to select from.

Variations

Extensions to this stereotype can be:
  • Multi Search. Being able to select more than just a single item from the list, e.g. selecting the regions an account manager works in. Add 1 to the complexity.
  • Extended Search. If it is functionally required to search on property values of classes which are not directly associated with the class of objects we are searching for, it is advised to use the Extended Search stereotype instead.

Estimation (3 - Average)

By default, a Search is estimated at 3. If multiple items need to be selected choose 4.
  Name Size