Parameters (OOM)

A parameter is a variable that can be changed, passed, or returned.To view or edit a parameter's properties, select it on the Parameters tab of an operation or event and click the Properties tool.

The General tab contains the following properties:

Property

Description

Parent

Specifies the operation or event to which the parameter belongs.

Name/Code/Comment

Identify the object. The name should clearly convey the object's purpose to non-technical users, while the code, which is used for generating code or scripts, may be abbreviated, and should not normally include spaces. You can optionally add a comment to provide more detailed information about the object. By default the code is generated from the name by applying the naming conventions specified in the model options. To decouple name-code synchronization, click to release the = button to the right of the Code field.

Stereotype

Extends the semantics of the object beyond the core UML definition. You can enter a stereotype directly in this field, or add stereotypes to the list by specifying them in an extension file.

Data type

Set of instances sharing the same operations, abstract attributes, relationships, and semantics.

Array

Specifies that the data type is a table format.

Array size

Specifies an accurate array size when the attribute multiplicity is greater than 1.

Variable Argument

Specifies that the method can take a variable number of parameters for a given argument. You can only select this property if the parameter is the last in the list.

Parameter Type

Direction of information flow for the parameter. You can choose from the following:
  • In - Input parameter passed by value. The final value may not be modified and information is not available to the caller.

  • In/Out - Input parameter that may be modified. The final value may be modified to communicate information to the caller.

  • Out - Output parameter. The final value may be modified to communicate information to the caller.

Default value

Default value when a parameter is omitted. For example:

Use an operation oper(string param1, integer param2), and specify two arguments oper(val1, val2) during invocation. Some languages, like C++, allow you to define a default value that is then memorized when the parameter is omitted during invocation.

If the declaration of the method is oper(string param1, integer param2 = default), then the invocation oper(val1) is similar to oper(val1, default).

WSDL data type

Only available with Web services. Defines the XML-Schema/SOAP type used during invocation of a Web method (using http or Soap)

Keywords

Provide a way of loosely grouping objects through tagging. To enter multiple keywords, separate them with commas.