Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.alfresco.service.cmr.action
Interface ParameterDefinition

public interface ParameterDefinition
Parameter definition interface.
Author:
Roy Wetherall

Method Summary
getDisplayLabel()
          Get the display label of the parameter.
getName()
          Get the name of the parameter.
getParameterConstraintName()
          Gets the parameter constraint name, null if none set.
getType()
          Get the type of parameter
boolean
isMandatory()
          Indicates whether the parameter is mandatory or not.
boolean
isMultiValued()
          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
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

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2016 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.