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 ParameterConstraint

@org.alfresco.api.AlfrescoPublicApi
public interface ParameterConstraint
Parameter constraint. Helps to constraint the list of allowable values for a action parameter.
Author:
Roy Wetherall

Method Summary
getAllowableValues()
          The implementers are expected to return allowed values in the insertion order.
getName()
          Gets the unique name of the constraint
getValueDisplayLabel(String value)
boolean
isValidValue(String value)
          Indicates whether the provided value satisfies the constraint.
Method Detail
getName
String getName()
Gets the unique name of the constraint
Returns:
String constraint name

isValidValue
boolean isValidValue(String value)
Indicates whether the provided value satisfies the constraint. True if it does, false otherwise.
Returns:
boolean true if valid, false otherwise

getValueDisplayLabel
String getValueDisplayLabel(String value)
Parameters:
value - String
Returns:
String

getAllowableValues
Map<StringgetAllowableValues()
The implementers are expected to return allowed values in the insertion order.

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–2018 Alfresco Software. All rights reserved.

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