Package org.alfresco.service.cmr.action

Interface ParameterDefinition

  • All Known Implementing Classes:
    ParameterDefinitionImpl
    @AlfrescoPublicApi
public interface ParameterDefinition
    Parameter definition interface.
    Author:
    Roy Wetherall

    • Method Detail

      • getName

        java.lang.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

        java.lang.String getDisplayLabel()
        Get the display label of the parameter.
        Returns:
        the parameter display label

      • getParameterConstraintName

        java.lang.String getParameterConstraintName()
        Gets the parameter constraint name, null if none set.
        Returns:
        the parameter constraint name