Type to start searching...

Result

Optional result specification for an Event.

Description
The result element provides the ability to provide constraints in the event result type.
Properties
collection : boolean

True if the return value is a collection of objects.

description : string

Result description.

If the result is described here it will be used in any generated documentation. This description will override @return descriptions in schemeDoc for the event. If only a schemeDoc @return description is provided it will be used in generated documentation.
required : boolean

True if the return value cannot be null.

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
  • Event - Events are the behaviors of Classes or Aspects.