Annotation Interface Input
The @Input annotation is an optional annotation for smart service setter methods that allows
for additional input behaviors to be described.
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionIf a picker for an input other than the type that is typically used for the input type is required, the customDisplayReference attribute can be used to refer to the name of the picker that should be used instead.String[]
The String representation of the default value of the input.If the input should be based on an enumeration, pass the name of the enumeration to this attribute.boolean
Determines whether the input will show up in the Data tab of the node in the process modeler.The localId attribute is used for converting pre-existing smart services to the annotated smart service plug-ins.Whether or not the input is required. -
Field Summary
-
Field Details
-
NULL
- See Also:
-
NOT_DEFINED
static final int NOT_DEFINED- See Also:
-
-
Element Details
-
defaultValue
String[] defaultValueThe String representation of the default value of the input. For multiple value inputs give the default value as an array of strings. For example, for a multiple Boolean:
{@code @Input(defaultValue={"false","true","true"})- Default:
- {"##default"}
-
required
Required requiredWhether or not the input is required. Use an item from theRequired
enumeration as the value. The default is for the input to be required.- Default:
- ALWAYS
-
enumeration
String enumerationIf the input should be based on an enumeration, pass the name of the enumeration to this attribute. The enumeration must be one of the provided enumerations inWEB-INF/conf/process/enumeration-config-process.xml
or a custom enumeration provided inWEB-INF/conf/process/enumeration-config-<custom>.xml
or provided in a plug-in.- Default:
- "##default"
-
localId
String localIdThe localId attribute is used for converting pre-existing smart services to the annotated smart service plug-ins. It should be used when the target system already has models that use the existing smart service that is being replaced by the new plug-in. The value of theactivity-class-parameter-schema
local-id should be passed to this attribute. Using this attribute is not required and not recommended for new smart service plug-ins.- Default:
- ""
-
customDisplayReference
String customDisplayReferenceIf a picker for an input other than the type that is typically used for the input type is required, the customDisplayReference attribute can be used to refer to the name of the picker that should be used instead. For example, to limit the picker for an input of type Group to just show Departments:
@Input(customDisplayReference="departments")
If the input is of type String, the value of"htmlarea"
can be passed to the attribute in order to change the standard text input to a rich text variation.- Default:
- "##default"
-