class ControllerMethodCodesnippet
Package: swiss.avm.up.core.generic.specification.interface_local.javamodel.ControllerMethodCodesnippet
Direct Known Subclasses:
class ControllerMethodCodesnippet extends AControllerMethod, AMethodParameter, AMethodLocalVariable, AControllerScopeCodesnippetImplementation
Controller methods are used to define functions that have controller-local validity.
The call is made via the this operator.
Example: this.method1()
Controller methods can be overridden in a derived controller. In an overridden controller, the base method can be called using the SUPER operator.
Example: SUPER.baseMethod1()
All elements of a controller can be used in the method: - Messages - All controller variables (local and interface) - ...
Properties
code
CodeSnippet[1..1]
comment
Describes the intent of this Resource.
TextLiteral[0..1]
A Literal that accepts multiple lines of text.
functionBlock
instance of existing function block to be used in function definition
FunctionFBInstance[0..N]
instance of function block within a function block
functionBlock
FunctionFBInstance[0..0]
instance of function block within a function block
hideCodeSnippet
Do not generate the code snippet
BooleanLiteral[0..1]
A literal where only the two values 'false' and 'true' are accepted.
inOutParameter
FieldComplexInput[0..N]
inputParameter
FieldComplexInput[0..N]
localVariable
local function block variable
FunctionLocalVariable[0..N]
local variable of a function block
name
The name of this Resource.
StringLiteral[1..1]
override
override existing base function
Resource[0..1]
The base class of any Resource in the system.
override
AControllerMethod[0..1]
A ControllerMethod is a named, reusable, typed method on a controller, defined
in its InterfaceLocal. It factors shared guard or helper logic out of inline
code snippets so it can be called from transition guards and from state code.
AControllerMethod is the abstract base; the concrete form carries a C-Minus
body.
returnType
AReturnType[1..1]
Method Summary
getComment
@FComments
getInOutParameter
@FControllerMethodCodesnippet
Return:
List<FieldComplexInput>
getInputParameter
@FControllerMethodCodesnippet
Return:
List<FieldComplexInput>