Package org.alfresco.service.cmr.action
Interface ParameterDefinition
-
- All Known Implementing Classes:
ParameterDefinitionImpl
@AlfrescoPublicApi public interface ParameterDefinitionParameter definition interface.- Author:
- Roy Wetherall
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDisplayLabel()Get the display label of the parameter.StringgetName()Get the name of the parameter.StringgetParameterConstraintName()Gets the parameter constraint name, null if none set.org.alfresco.service.namespace.QNamegetType()Get the type of parameterbooleanisMandatory()Indicates whether the parameter is mandatory or not.booleanisMultiValued()Is multi-valued?
-
-
-
Method Detail
-
getName
String getName()
Get the name of the parameter.This is unique and is used to identify the parameter.
- Returns:
- the parameter name
-
getType
org.alfresco.service.namespace.QName getType()
Get the type of parameter- Returns:
- the parameter type qname
-
isMultiValued
boolean isMultiValued()
Is multi-valued?
-
isMandatory
boolean isMandatory()
Indicates whether the parameter is mandatory or not.If a parameter is mandatory it means that the value can not be null.
- Returns:
- true if the parameter is mandatory, false otherwise
-
getDisplayLabel
String getDisplayLabel()
Get the display label of the parameter.- Returns:
- the parameter display label
-
getParameterConstraintName
String getParameterConstraintName()
Gets the parameter constraint name, null if none set.- Returns:
- the parameter constraint name
-
-