Argument

Detailed specification of arguments for a class/aspect event.

Description

If not specified here, the argument will be of type any, not required, non collection with no description.

Properties

collection : boolean

True if the argument provides a collection of objects.

description : string

Argument description.

If the argument is described here it will be used in any generated documentation. This description will override @arg descriptions in schemeDoc for the event. If only a schemeDoc @arg description is provided it will be used in generated documentation.

name : identifier

Argument name. Usually starts with lower case.

The argument name must exist and be unique within the args property.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

required : boolean

True if the value cannot be null when calling the event.

type : identifier

Primitive type or a class within the domain model.

Example

string, integer, FinancialAccount...

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

Parents

• Arguments - Collection of optional argument details for an Event. (Class or Aspect Events)